enumsStructs Namespace Reference

Classes
struct	BoundarySet
struct	DirectSumSimulationParameters
struct	LinkedCellsSimulationParameters
struct	Cuboid
struct	Disc
struct	Sphere
struct	ParticleType
struct	ThermostatParameters
struct	MembraneParameters
struct	SimulationSettings

Enumerations
enum class	Side {   front , right , back , left ,   top , bottom }
enum class	TypeOfForce { gravity , lennardJonesForce , invalid }
enum class	TypeOfModel { directSum , linkedCells , invalid }
enum class	BoundaryCondition { outflow , reflective , periodic , invalid }
enum class	TypeOfThermostat { defaultThermostat , flowThermostat }
enum class	ParallelizationStrategy { none , linear , skipping , reduction }

Functions
TypeOfForce	setForce (const std::string &selectedForce)
	Convert string selection to enum value. More...
std::string	getForce (TypeOfForce &force)
	Convert enum value to string. More...
TypeOfModel	setModel (const std::string &selectedModel)
	Convert string selection to corresponding enum value. More...
std::string	getModel (TypeOfModel &model)
	Convert enum value to string. More...
BoundaryCondition	setBoundaryCondition (const std::string &selectedBoundaryCondition)
	Convert string selection to corresponding enum value. More...
std::string	getBoundaryCondition (BoundaryCondition &boundaryCondition)
	Convert enum value to string. More...
TypeOfThermostat	setTypeOfThermostat (const std::string &typeOfThermostat)
	Convert string selection to corresponding enum value. More...
ParallelizationStrategy	setTypeOfParallelizationStrategy (const std::string &typeOfParallelizationStrategy)
	Convert string selection to corresponding enum value. More...

Enumeration Type Documentation

BoundaryCondition

enum enumsStructs::BoundaryCondition

strong

Enum to distinguish between different boundary conditions for each side.

Enumerator
outflow
reflective
periodic
invalid

ParallelizationStrategy

enum enumsStructs::ParallelizationStrategy

strong

Enumerator
none
linear
skipping
reduction

Side

enum enumsStructs::Side

strong

Enum to specify the side that can be chosen in some methods.

Enumerator
front
right
back
left
top
bottom

TypeOfForce

enum enumsStructs::TypeOfForce

strong

Enum to specify the type of force used in the simulation.

Enumerator
gravity
lennardJonesForce
invalid

TypeOfModel

enum enumsStructs::TypeOfModel

strong

Enum to specify the type of model used in the simulation.

Enumerator
directSum
linkedCells
invalid

TypeOfThermostat

enum enumsStructs::TypeOfThermostat

strong

Enumerator
defaultThermostat
flowThermostat

Function Documentation

getBoundaryCondition()

std::string enumsStructs::getBoundaryCondition ( BoundaryCondition &  boundaryCondition )

inline

Convert enum value to string.

Parameters

boundaryCondition

Enum value to convert.

Returns

Corresponding string.

getForce()

std::string enumsStructs::getForce ( TypeOfForce &  force )

inline

Convert enum value to string.

Parameters

force

Enum value to convert.

Returns

Corresponding string.

getModel()

std::string enumsStructs::getModel ( TypeOfModel &  model )

inline

Convert enum value to string.

Parameters

model

Enum value to convert.

Returns

Corresponding string.

setBoundaryCondition()

BoundaryCondition enumsStructs::setBoundaryCondition ( const std::string &  selectedBoundaryCondition )

inline

Convert string selection to corresponding enum value.

Parameters

selectedBoundaryCondition

String to convert.

Returns

Corresponding enum value.

Here is the caller graph for this function:

setForce()

TypeOfForce enumsStructs::setForce ( const std::string &  selectedForce )

inline

Convert string selection to enum value.

Parameters

selectedForce

String to convert.

Returns

Corresponding enum value.

Here is the caller graph for this function:

setModel()

TypeOfModel enumsStructs::setModel ( const std::string &  selectedModel )

inline

Convert string selection to corresponding enum value.

Parameters

selectedModel

String to convert.

Returns

Corresponding enum value.

Here is the caller graph for this function:

setTypeOfParallelizationStrategy()

ParallelizationStrategy enumsStructs::setTypeOfParallelizationStrategy ( const std::string &  typeOfParallelizationStrategy )

inline

Convert string selection to corresponding enum value.

Parameters

typeOfParallelizationStrategy

String to convert.

Returns

Corresponding enum value.

Here is the caller graph for this function:

setTypeOfThermostat()

TypeOfThermostat enumsStructs::setTypeOfThermostat ( const std::string &  typeOfThermostat )

inline

Convert string selection to corresponding enum value.

Parameters

typeOfThermostat

String to convert.

Returns

Corresponding enum value.

Here is the caller graph for this function: