class representing a boundary node More...

#include <BoundaryNode.hpp>

Inheritance diagram for LbmLib::nodes::BoundaryNode:

Public Member Functions
	BoundaryNode (double x, double y, const std::map< std::string, std::vector< std::string > > &connectionType, unsigned int domainId)
	BoundaryNode Constructor for a boundary node. More...

	~BoundaryNode ()
	~BoundaryNode Destructor

void	setPhysicalNeighbours (PhysicalNode *const physicalNode, const Direction &dir)
	setPhysicalNeighbours Sets the corresponding Physical neighbours of this node More...

PhysicalNode *	getPhysicalNeighbour () const
	getFluidNeighbour Getter for the Physical neighbour More...

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...

solver::BoundaryAbstractSolver &	getBoundarySolver (const std::string &name)
	getBoundarySolver Getter method for the boundary Solver More...

std::map< std::string, solver::BoundaryAbstractSolver * > &	getBoundarySolvers ()
	getBoundarySolvers Getter method for all Boundary Solvers More...

Direction	getDirectionToNeighbour () const
	getDirectionToNeighbour returns the direction to the next neighbour More...

unsigned int	getDomainIdentifier () const
	getDomainIdentifier Getter for the domain Identifier More...

Public Member Functions inherited from LbmLib::nodes::LagrangianPoint
	LagrangianPoint (double x, double y)
	LagrangianPoint Constructs a new point. More...

virtual	~LagrangianPoint ()
	~LagrangianPoint vitual Destructor

double	getXVelocity () const
	getXVelocity Getter for x-velocity component More...

double	getYVelocity () const
	getYVelocity Getter for the y-velocity component More...

Field< double >	getVelocity () const
	getVelocity Getter for the velocity More...

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

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

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

virtual void	setPos (double x, double y)
	setPos Set the position new override this method to change default behaviour More...

void	setXPos (double x)
	setXPos Set a new x position. More...

void	setYPos (double y)
	setYPos Set a new y position. More...

virtual void	setVelocity (Field< double > velocity)
	setVelocity Set the velocity More...

Detailed Description

class representing a boundary node

Definition at line 46 of file BoundaryNode.hpp.

Constructor & Destructor Documentation

LbmLib::nodes::BoundaryNode::BoundaryNode	(	double	x,
		double	y,
		const std::map< std::string, std::vector< std::string > > &	connectionType,
		unsigned int	domainId
	)

explicit

BoundaryNode Constructor for a boundary node.

Parameters

x	The x pos
y	The y pos
connectionType	The connection of the solvers
domainId	the domain id this node belongs to

Definition at line 35 of file BoundaryNode.cpp.

Member Function Documentation

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

dumpNode dumps the node for dot

Parameters

oStream The stream this node is dumped to

Definition at line 112 of file BoundaryNode.cpp.

solver::BoundaryAbstractSolver & LbmLib::nodes::BoundaryNode::getBoundarySolver ( const std::string & name )

getBoundarySolver Getter method for the boundary Solver

Parameters

name	The name of the Boundary solver

Returns: The Boundary solver at this node

Definition at line 83 of file BoundaryNode.cpp.

std::map< std::string, solver::BoundaryAbstractSolver * > & LbmLib::nodes::BoundaryNode::getBoundarySolvers ( )

getBoundarySolvers Getter method for all Boundary Solvers

Returns: All Boundary Solvers

Definition at line 96 of file BoundaryNode.cpp.

Direction LbmLib::nodes::BoundaryNode::getDirectionToNeighbour ( ) const

getDirectionToNeighbour returns the direction to the next neighbour

Returns: the direction to the next neighbour

Definition at line 71 of file BoundaryNode.cpp.

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

getDomainIdentifier Getter for the domain Identifier

Returns: the domainIdentifier of this boundary Node

Definition at line 49 of file BoundaryNode.cpp.

PhysicalNode * LbmLib::nodes::BoundaryNode::getPhysicalNeighbour ( ) const

getFluidNeighbour Getter for the Physical neighbour

Returns: A Pointer to the Physical neighbour

Definition at line 75 of file BoundaryNode.cpp.

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

virtual

getType The type of a node class

Returns: Returns the class Name of the point

Reimplemented from LbmLib::nodes::LagrangianPoint.

Definition at line 79 of file BoundaryNode.cpp.

void LbmLib::nodes::BoundaryNode::setPhysicalNeighbours	(	PhysicalNode *const	physicalNode,
		const Direction &	dir
	)

setPhysicalNeighbours Sets the corresponding Physical neighbours of this node

Parameters

physicalNode	The physical Neighbour
dir	The direction of the physical neighbour

Definition at line 59 of file BoundaryNode.cpp.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation