Class used to construct OpenMPCD::CUDA::BoundaryCondition::Base instances. More...

#include <Factory.hpp>

Static Public Member Functions
static BoundaryCondition::Base *	getInstance (const Configuration::Setting &config, const unsigned int simulationBoxSizeX, const unsigned int simulationBoxSizeY, const unsigned int simulationBoxSizeZ)
	Returns a newly constructed boundary condition instance. More...

Detailed Description

Class used to construct OpenMPCD::CUDA::BoundaryCondition::Base instances.

Boundary conditions are configured in the OpenMPCD configuration file in the boundaryConditions setting, which has to contain exactly one configuration group, the name of which decides which type of boundary condition to use.

Definition at line 28 of file BoundaryCondition/Factory.hpp.

Member Function Documentation

◆ getInstance()

BoundaryCondition::Base * OpenMPCD::CUDA::BoundaryCondition::Factory::getInstance	(	const Configuration::Setting &	config,
		const unsigned int	simulationBoxSizeX,
		const unsigned int	simulationBoxSizeY,
		const unsigned int	simulationBoxSizeZ
	)

static

Returns a newly constructed boundary condition instance.

The caller is responsible for deleting the pointer.

Exceptions

OpenMPCD::InvalidConfigurationException Throws if either no, or multiple, boundary conditions have been defined in the given configuration group, or none of the configured boundary conditions are recognized.

Parameters

[in]	config	The configuration group that holds the boundary condition configuration.
[in]	simulationBoxSizeX	The size of the primary simulation volume along the `x` direction.
[in]	simulationBoxSizeY	The size of the primary simulation volume along the `y` direction.
[in]	simulationBoxSizeZ	The size of the primary simulation volume along the `z` direction.

Definition at line 14 of file BoundaryCondition/Factory.cpp.

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getInstance()