The LagrangianPoint class A class for storing a point's coordinates and its velocity This class is the base class for all points which have a velocity and can be at any position. More...

#include <LagrangianPoint.hpp>

Inheritance diagram for LbmLib::nodes::LagrangianPoint:

Public Member Functions
	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...

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

Detailed Description

The LagrangianPoint class A class for storing a point's coordinates and its velocity This class is the base class for all points which have a velocity and can be at any position.

Definition at line 35 of file LagrangianPoint.hpp.

Constructor & Destructor Documentation

LbmLib::nodes::LagrangianPoint::LagrangianPoint	(	double	x,
		double	y
	)

explicit

LagrangianPoint Constructs a new point.

Parameters

x	The x position
y	The y position

Definition at line 35 of file LagrangianPoint.cpp.

Member Function Documentation

Field< double > LbmLib::nodes::LagrangianPoint::getPos ( ) const

getPos Getter for the pos

Returns: The position

Definition at line 65 of file LagrangianPoint.cpp.

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

virtual

getType The type of a node class

Returns: Returns the class Name of the point

Reimplemented in LbmLib::nodes::GeometryNode, and LbmLib::nodes::BoundaryNode.

Definition at line 88 of file LagrangianPoint.cpp.

Field< double > LbmLib::nodes::LagrangianPoint::getVelocity ( ) const

getVelocity Getter for the velocity

Returns: The velocity

Definition at line 51 of file LagrangianPoint.cpp.

double LbmLib::nodes::LagrangianPoint::getXPos ( ) const

getXPos Getter for the X position

Returns: the x pos

Definition at line 57 of file LagrangianPoint.cpp.

double LbmLib::nodes::LagrangianPoint::getXVelocity ( ) const

getXVelocity Getter for x-velocity component

Returns: the x-velocity component

Definition at line 43 of file LagrangianPoint.cpp.

double LbmLib::nodes::LagrangianPoint::getYPos ( ) const

getYPos Getter for the Y position

Returns: the y pos

Definition at line 61 of file LagrangianPoint.cpp.

double LbmLib::nodes::LagrangianPoint::getYVelocity ( ) const

getYVelocity Getter for the y-velocity component

Returns: the x-velocity component

Definition at line 47 of file LagrangianPoint.cpp.

void LbmLib::nodes::LagrangianPoint::setPos	(	double	x,
		double	y
	)

virtual

setPos Set the position new override this method to change default behaviour

Parameters

x	The new x position
y	The new y position

Reimplemented in LbmLib::nodes::GeometryNode.

Definition at line 69 of file LagrangianPoint.cpp.

void LbmLib::nodes::LagrangianPoint::setVelocity ( Field< double > velocity )

virtual

setVelocity Set the velocity

Parameters

velocity The new velocity

Definition at line 92 of file LagrangianPoint.cpp.

void LbmLib::nodes::LagrangianPoint::setXPos ( double x )

setXPos Set a new x position.

Parameters

x	The new x position.

Definition at line 76 of file LagrangianPoint.cpp.

void LbmLib::nodes::LagrangianPoint::setYPos ( double y )

setYPos Set a new y position.

Parameters

y	The new y position

Definition at line 82 of file LagrangianPoint.cpp.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation