TissueForge::BoundaryConditions Struct Reference

The BoundaryConditions class serves as a container for the six instances of the :class:BoundaryCondition object. More...

#include <tfBoundaryConditions.h>

Collaboration diagram for TissueForge::BoundaryConditions:

Public Member Functions
	BoundaryConditions (int *cells)
	BoundaryConditions (int *cells, const int &value)
	BoundaryConditions (int *cells, const std::unordered_map< std::string, unsigned int > vals, const std::unordered_map< std::string, FVector3 > vels, const std::unordered_map< std::string, FPTYPE > restores)
void	set_potential (struct ParticleType *ptype, struct Potential *pot)
	sets a potential for ALL boundary conditions and the given potential.
std::string	str ()
std::string	toString ()
	Get a JSON string representation.

Static Public Member Functions
static void	boundedPosition (FVector3 &position)
	Enforce boundary conditions on a position.
static FVector3	boundedPosition (const FVector3 &position)
	Enforce boundary conditions on a position.
static unsigned	boundaryKindFromString (const std::string &s)
static unsigned	boundaryKindFromStrings (const std::vector< std::string > &kinds)
static BoundaryConditions *	fromString (const std::string &str)
	Create from a JSON string representation.

Public Attributes
BoundaryCondition	top
	The top boundary.
BoundaryCondition	bottom
	The bottom boundary.
BoundaryCondition	left
	The left boundary.
BoundaryCondition	right
	The right boundary.
BoundaryCondition	front
	The front boundary.
BoundaryCondition	back
	The back boundary.
struct Potential **	potenntials
uint32_t	periodic

Detailed Description

The BoundaryConditions class serves as a container for the six instances of the :class:BoundaryCondition object.

Member Function Documentation

fromString()

static BoundaryConditions * TissueForge::BoundaryConditions::fromString ( const std::string & str )

static

Create from a JSON string representation.

Parameters

str

Returns

BoundaryConditions*

set_potential()

void TissueForge::BoundaryConditions::set_potential	(	struct ParticleType *	ptype,
		struct Potential *	pot )

sets a potential for ALL boundary conditions and the given potential.

Parameters

ptype	particle type
pot	potential

toString()

std::string TissueForge::BoundaryConditions::toString

(

)

Get a JSON string representation.

Returns

std::string

Member Data Documentation

periodic

uint32_t TissueForge::BoundaryConditions::periodic

bitmask of periodic boundary conditions

---

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

• source/mdcore/include/tfBoundaryConditions.h