Arguments Struct Reference

Struct containing each option configurable via command line arguments. More...

#include <Arguments.h>

Public Member Functions
std::string	toString () const
	Returns a string representation of the struct.
bool	operator== (const Arguments &other) const
	Overload of the equality operator. Checks if two Arguments structs contain the same values.

Public Attributes
double	startTime {}
	Start time of a simulation (default: simulation-specific).
double	endTime {}
	End time of a simulation (default: simulation-specific).
double	delta_t {}
	Duration of a timestep (default: simulation-specific).
int	itFreq {10}
	Logging frequency (default: every 10 iterations)
std::array< double, 3 >	domainSize {INFINITY, INFINITY, INFINITY}
	Domain size for linked cells (default: unspecified, will fail if not specified!)
double	cutoffRadius {3.0}
	Cutoff radius for linked cells (default: 3.0)
double	gravity {0.0}
	The gravity that the particles are exposed to (default: 0).
std::string	basename {}
	The basename of the output file (default: type-specific).
WriterType	type {WriterType::VTK}
	Output type (default: VTK).
SimulationType	sim {SimulationType::LJ}
	Simulation type (default: LJ).
ParallelizationType	parallelization {ParallelizationType::COARSE}
	Parallelization type (default: coarse-grained).
bool	linkedCells {true}
	Decide, whether or not to use the linked cell method (default: true)
std::array< BoundaryCondition, 6 >	conditions
	The type of condition to be applied at each boundary (default: outflow)
size_t	dimensions {2}
	The dimensions of the simulation, either 2 or 3 (default: 2).
bool	membrane {false}
	Determines, whether the simulation is a membrane simulation or not.
std::bitset< 4 >	argsSet {0b0000}
	Bitset containing flags, whether startTime (0), endTime (1), delta_t (2) and basename (3) have been manually set by the user. If not, use default values depending on the simulation.

Detailed Description

Struct containing each option configurable via command line arguments.

Member Function Documentation

operator==()

bool Arguments::operator== ( const Arguments &  other ) const

inline

Overload of the equality operator. Checks if two Arguments structs contain the same values.

Does not check if argsSet is the same.

Parameters

other

The Arguments structed to compare the current one with.

Returns

true if both structs contain the same values.

false if both structs do not contain the same values.

toString()

std::string Arguments::toString ( ) const

inline

Returns a string representation of the struct.

Returns

A string representation of the struct.

Member Data Documentation

argsSet

std::bitset<4> Arguments::argsSet {0b0000}

Bitset containing flags, whether startTime (0), endTime (1), delta_t (2) and basename (3) have been manually set by the user. If not, use default values depending on the simulation.

basename

std::string Arguments::basename {}

The basename of the output file (default: type-specific).

conditions

std::array<BoundaryCondition, 6> Arguments::conditions

Initial value:

{BoundaryCondition::OUTFLOW, BoundaryCondition::OUTFLOW,
                                                BoundaryCondition::OUTFLOW, BoundaryCondition::OUTFLOW,
                                                BoundaryCondition::OUTFLOW, BoundaryCondition::OUTFLOW}

The type of condition to be applied at each boundary (default: outflow)

cutoffRadius

double Arguments::cutoffRadius {3.0}

Cutoff radius for linked cells (default: 3.0)

delta_t

double Arguments::delta_t {}

Duration of a timestep (default: simulation-specific).

dimensions

size_t Arguments::dimensions {2}

The dimensions of the simulation, either 2 or 3 (default: 2).

domainSize

std::array<double, 3> Arguments::domainSize {INFINITY, INFINITY, INFINITY}

Domain size for linked cells (default: unspecified, will fail if not specified!)

endTime

double Arguments::endTime {}

End time of a simulation (default: simulation-specific).

gravity

double Arguments::gravity {0.0}

The gravity that the particles are exposed to (default: 0).

itFreq

int Arguments::itFreq {10}

Logging frequency (default: every 10 iterations)

linkedCells

bool Arguments::linkedCells {true}

Decide, whether or not to use the linked cell method (default: true)

membrane

bool Arguments::membrane {false}

Determines, whether the simulation is a membrane simulation or not.

parallelization

ParallelizationType Arguments::parallelization {ParallelizationType::COARSE}

Parallelization type (default: coarse-grained).

sim

SimulationType Arguments::sim {SimulationType::LJ}

Simulation type (default: LJ).

startTime

double Arguments::startTime {}

Start time of a simulation (default: simulation-specific).

type

WriterType Arguments::type {WriterType::VTK}

Output type (default: VTK).

---

The documentation for this struct was generated from the following file:

• src/utils/Arguments.h