class representing a physical node More...

#include <PhysicalNode.hpp>

Inheritance diagram for LbmLib::nodes::PhysicalNode:

Public Member Functions
	PhysicalNode (int x, int y)
	PhysicalNode constructs a physical node. More...

	~PhysicalNode ()
	~PhysicalNode Destructor

void	setPhysicalNeighbour (PhysicalNode *const node, const Direction &d)
	setPhysicalNeighbour Setter for the neighbour fluid point More...

void	setBoundaryNeighbour (BoundaryNode *const boundaryNode, const Direction &d)
	setBoundaryNeighbour Setter for the neighbour boundary point More...

BoundaryNode *	getBoundaryNeighbour (const Direction &d) const
	getBoundaryNeighbour Getter method to access the Boundary Neighbour More...

PhysicalNode *	getPhysicalNeighbour (const Direction &d) const
	getPhysicalNeighbour Getter method to access the Physical Neighbour More...

void	resetBoundaryNodes ()
	resetBoundaryNodes Resets the boundary nodes to nullptr

virtual std::string	getType () const
	getType The type of a node class More...

void	dumpNode (std::ostream *oStream) const
	dumpNode dumps the node for dot More...

const solver::FluidSolver &	getFluidSolver () const
	getFluidSolver Const getter method for the fluid Solver More...

solver::FluidSolver &	getFluidSolver ()
	getFluidSolver Getter method for the fluid Solver More...

solver::CDEAbstractSolver &	getCDESolver (size_t id) const
	getCDESolver Getter method for the cde Solver More...

solver::CDEAbstractSolver &	getCDESolverSlow (const std::string &name) const
	getCDESolverSlow Getter method for the cde Solver More...

std::vector < solver::CDEAbstractSolver * > &	getCDESolvers ()
	getCDESolvers Getter method for all CDE Solvers More...

void	addCDESolver (const std::string &cdeSolverName)
	addCDESolver Adds a CDESolver to this node More...

void	updateDomainIdentifier ()
	updateDomainIdentifier updates the domain Identifier of this node. If the domain changes it returns true otherwise false if domain identifier has changed, it will be logged at debug 3 level

unsigned int	getDomainIdentifier () const
	getter for the Domain Identifier of this node More...

void	setDomainIdentifier (unsigned int domainIdentifier)
	setDomainIdentifier setter for the domain identifier More...

unsigned int	getCellType () const
	getter for the cell type of this node More...

void	setCellType (unsigned int celltype)
	setCellType setter for the celltype More...

Public Member Functions inherited from LbmLib::nodes::EulerianPoint
	EulerianPoint (int x, int y)
	EulerianPoint Constructs a new EulerianPoint. More...

virtual	~EulerianPoint ()
	~Point vitual Destructor

int	getXPos () const
	getXPos Getter for the X position More...

int	getYPos () const
	getYPos Getter for the Y position More...

Field< int >	getPos () const
	getPos Getter for the pos More...

Detailed Description

class representing a physical node

Definition at line 45 of file PhysicalNode.hpp.

Constructor & Destructor Documentation

LbmLib::nodes::PhysicalNode::PhysicalNode	(	int	x,
		int	y
	)

explicit

PhysicalNode constructs a physical node.

Parameters

x	the x pos
y	the y pos

Definition at line 39 of file PhysicalNode.cpp.

Member Function Documentation

void LbmLib::nodes::PhysicalNode::addCDESolver ( const std::string & cdeSolverName )

addCDESolver Adds a CDESolver to this node

Parameters

cdeSolverName The name of the cde Solver added

Definition at line 62 of file PhysicalNode.cpp.

void LbmLib::nodes::PhysicalNode::dumpNode ( std::ostream * oStream ) const

dumpNode dumps the node for dot

Parameters

oStream The stream this node is dumped to

Definition at line 187 of file PhysicalNode.cpp.

BoundaryNode * LbmLib::nodes::PhysicalNode::getBoundaryNeighbour ( const Direction & d ) const

getBoundaryNeighbour Getter method to access the Boundary Neighbour

Parameters

d	The direction of the neighbour

Returns: A Pointer to the boundary neighbour

Definition at line 101 of file PhysicalNode.cpp.

solver::CDEAbstractSolver & LbmLib::nodes::PhysicalNode::getCDESolver ( size_t id ) const

getCDESolver Getter method for the cde Solver

Parameters

id	The id of the CDE solver

Returns: The cde solver on this node

Definition at line 166 of file PhysicalNode.cpp.

std::vector< solver::CDEAbstractSolver * > & LbmLib::nodes::PhysicalNode::getCDESolvers ( )

getCDESolvers Getter method for all CDE Solvers

Returns: All CDE Solvers

Definition at line 183 of file PhysicalNode.cpp.

solver::CDEAbstractSolver & LbmLib::nodes::PhysicalNode::getCDESolverSlow ( const std::string & name ) const

getCDESolverSlow Getter method for the cde Solver

Attention: this method is slow prefere the getCDESolver method above

Parameters

name	The name of the CDE solver

Returns: The cde solver on this node

Definition at line 170 of file PhysicalNode.cpp.

unsigned int LbmLib::nodes::PhysicalNode::getCellType ( ) const

getter for the cell type of this node

Returns: the cell type of this node

Definition at line 134 of file PhysicalNode.cpp.

unsigned int LbmLib::nodes::PhysicalNode::getDomainIdentifier ( ) const

getter for the Domain Identifier of this node

Returns: the Domain Identifier of this node

Definition at line 126 of file PhysicalNode.cpp.

const solver::FluidSolver & LbmLib::nodes::PhysicalNode::getFluidSolver ( ) const

getFluidSolver Const getter method for the fluid Solver

Returns: The Fluid Solver on this node.

Definition at line 158 of file PhysicalNode.cpp.

solver::FluidSolver & LbmLib::nodes::PhysicalNode::getFluidSolver ( )

getFluidSolver Getter method for the fluid Solver

Returns: The Fluid Solver on this node.

Definition at line 162 of file PhysicalNode.cpp.

PhysicalNode * LbmLib::nodes::PhysicalNode::getPhysicalNeighbour ( const Direction & d ) const

getPhysicalNeighbour Getter method to access the Physical Neighbour

Parameters

d	The direction of the neighbour

Returns: A Pointer to the physical neighbour

Definition at line 105 of file PhysicalNode.cpp.

std::string LbmLib::nodes::PhysicalNode::getType ( ) const

virtual

getType The type of a node class

Returns: Returns the class Name of the point

Implements LbmLib::nodes::EulerianPoint.

Definition at line 154 of file PhysicalNode.cpp.

void LbmLib::nodes::PhysicalNode::setBoundaryNeighbour	(	BoundaryNode *const	boundaryNode,
		const Direction &	d
	)

setBoundaryNeighbour Setter for the neighbour boundary point

Parameters

boundaryNode	A pointer to the neighbour boundary point
d	The direction

Definition at line 93 of file PhysicalNode.cpp.

void LbmLib::nodes::PhysicalNode::setCellType ( unsigned int celltype )

setCellType setter for the celltype

Parameters

celltype the new celltype

Definition at line 138 of file PhysicalNode.cpp.

void LbmLib::nodes::PhysicalNode::setDomainIdentifier ( unsigned int domainIdentifier )

setDomainIdentifier setter for the domain identifier

Parameters

domainIdentifier the new identifier

Definition at line 130 of file PhysicalNode.cpp.

void LbmLib::nodes::PhysicalNode::setPhysicalNeighbour	(	PhysicalNode *const	node,
		const Direction &	d
	)

setPhysicalNeighbour Setter for the neighbour fluid point

Parameters

node	A pointer to the neighbour fluid point
d	The direction

Definition at line 85 of file PhysicalNode.cpp.

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

/home/tanakas/Documents/13_LBMCELL/lbmsolver/libs/LbmLib/include/nodes/PhysicalNode.hpp
/home/tanakas/Documents/13_LBMCELL/lbmsolver/libs/LbmLib/src/nodes/PhysicalNode.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation