Param Class Reference

Contains the parameters of the simulation & CG. More...

#include <IOLiggghts.h>

Classes
struct	ExtaField
struct	File

Public Member Functions
void	from_json (json &j)
void	from_file (char path[])
void	disp ()
void	from_json (json &j)
int	read_timestep (int ts, bool particleonly=false)
int	set_data (Data &cgdata)
int	get_num_particles ()
int	get_num_contacts ()
double	get_volume ()
double *	get_data (DataValue datavalue, int dd=0, std::string name="")
void	post_init ()

Public Attributes
string	atmdump =""
string	cfdump =""
int	skipT =0
int	maxT =1
vector< string >	flags = {}
const int	dim =3
vector< int >	boxes = {3,3,3}
vector< vector< double > >	boundaries ={{0,0,0},{1,1,1}}
string	save =""
vector< string >	saveformat
std::map< std::string, std::string >	cfmapping
bool	hascf = false
bool	dotimeavg = false
uint8_t	maxlevel = 3
string	windowstr = ""
Windows	window = Windows::Lucy3D
double	windowsize = 1
vector< bool >	periodicity
vector< double >	delta
vector< ExtaField >	extrafields
string	dump
double	rho
int	pbc = 0
vector< double >	Delta
vector< double >	radius
double	cuttoff = 2.5
int	dim =-1
double	default_density =-1
double	default_radius =-1
std::vector< double >	default_sqaxes {-1.,-1.,-1.}
std::vector< double >	default_sqpower {2,2,2}
AverageType	timeaverage = AverageType::None
std::map< std::string, bool >	requiredfieldset = {{"dimension", false}, {"window size", false}, {"fields", false}, {"max time", false}, {"boundaries", false}, {"boxes", false}}
std::vector< File >	files
int	curts =0
bool	tsread = false

Private Member Functions
void	post_init ()
int	parsing (istream &in)
int	identify_max_level ()
Windows	identify_window (std::string windowname)
void	process_extrafields (json &j)
void	process_file (json &j)

Private Attributes
bool	needmaxts = true
bool	needbounds = true

Detailed Description

Contains the parameters of the simulation & CG.

Member Function Documentation

disp()

void Param::disp ( )

inline

from_file()

void Param::from_file ( char  path[] )

inline

from_json() [1/2]

void Param::from_json

(

json &

j

)

from_json() [2/2]

void Param::from_json

(

json &

j

)

get_data()

double * Param::get_data	(	DataValue	datavalue,
		int	dd = 0,
		std::string	name = ""
	)

get_num_contacts()

int Param::get_num_contacts

(

)

get_num_particles()

int Param::get_num_particles

(

)

get_volume()

double Param::get_volume

(

)

identify_max_level()

int Param::identify_max_level ( )

private

identify_window()

Windows Param::identify_window ( std::string  windowname )

private

parsing()

int Param::parsing ( istream &  in )

private

post_init() [1/2]

void Param::post_init ( )

private

post_init() [2/2]

void Param::post_init

(

)

process_extrafields()

void Param::process_extrafields ( json &  j )

private

process_file()

void Param::process_file ( json &  j )

private

read_timestep()

int Param::read_timestep	(	int	ts,
		bool	particleonly = false
	)

set_data()

int Param::set_data

(

Data &

cgdata

)

Member Data Documentation

atmdump

string Param::atmdump =""

boundaries

vector< vector< double > > Param::boundaries ={{0,0,0},{1,1,1}}

boxes

vector< int > Param::boxes = {3,3,3}

cfdump

string Param::cfdump =""

cfmapping

std::map<std::string, std::string> Param::cfmapping

curts

int Param::curts =0

cuttoff

double Param::cuttoff = 2.5

default_density

double Param::default_density =-1

default_radius

double Param::default_radius =-1

default_sqaxes

std::vector<double> Param::default_sqaxes {-1.,-1.,-1.}

default_sqpower

std::vector<double> Param::default_sqpower {2,2,2}

delta

vector< double > Param::delta

Delta

vector<double> Param::Delta

dim [1/2]

const int Param::dim =3

dim [2/2]

int Param::dim =-1

dotimeavg

bool Param::dotimeavg = false

dump

string Param::dump

extrafields

vector< ExtaField > Param::extrafields

files

std::vector<File> Param::files

flags

vector< string > Param::flags = {}

hascf

bool Param::hascf = false

maxlevel

uint8_t Param::maxlevel = 3

maxT

int Param::maxT =1

needbounds

bool Param::needbounds = true

private

needmaxts

bool Param::needmaxts = true

private

pbc

int Param::pbc = 0

periodicity

vector< bool > Param::periodicity

radius

vector<double> Param::radius

requiredfieldset

std::map<std::string, bool> Param::requiredfieldset = {{"dimension", false}, {"window size", false}, {"fields", false}, {"max time", false}, {"boundaries", false}, {"boxes", false}}

rho

double Param::rho

save

string Param::save =""

saveformat

vector< string > Param::saveformat

skipT

int Param::skipT =0

timeaverage

AverageType Param::timeaverage = AverageType::None

tsread

bool Param::tsread = false

window

Windows Param::window = Windows::Lucy3D

windowsize

double Param::windowsize = 1

windowstr

string Param::windowstr = ""

---

The documentation for this class was generated from the following files:

• /home/runner/work/NDDEM/NDDEM/src/CoarseGraining/IOLiggghts.h
• /home/runner/work/NDDEM/NDDEM/src/CoarseGraining/IONDDEM.h
• /home/runner/work/NDDEM/NDDEM/src/CoarseGraining/Parameters.h