LBIBCell
 All Classes Functions Variables Friends Pages
LbmLib::solver::ForceStructs::ForceType2 Struct Reference

a free force on a node More...

#include <ForceStructs.hpp>

Inheritance diagram for LbmLib::solver::ForceStructs::ForceType2:
LbmLib::solver::AbstractForceStruct

Public Member Functions

 ForceType2 (unsigned int id1, double fx, double fy)
 the constructor of this force More...
 
void calculateForce (const std::map< unsigned int, std::shared_ptr< nodes::GeometryNode > > &nodes)
 calculates the force on the geometry nodes More...
 
void writeForceStruct (std::ofstream *const stream) const
 writes the force struct to the ostream More...
 
unsigned int getType () const
 Returns the force type. More...
 
unsigned int getPartnerGeometryNode (void) const
 getPartnerGeometryNode More...
 
- Public Member Functions inherited from LbmLib::solver::AbstractForceStruct
virtual ~AbstractForceStruct ()
 Destructor.
 

Detailed Description

a free force on a node

Definition at line 192 of file ForceStructs.hpp.

Constructor & Destructor Documentation

LbmLib::solver::ForceStructs::ForceType2::ForceType2 ( unsigned int  id1,
double  fx,
double  fy 
)
inline

the constructor of this force

Parameters
id1the id of the node the free force is applied
fxthe free force in x direction
fythe free force in y direction

Definition at line 199 of file ForceStructs.hpp.

Member Function Documentation

void LbmLib::solver::ForceStructs::ForceType2::calculateForce ( const std::map< unsigned int, std::shared_ptr< nodes::GeometryNode > > &  nodes)
inlinevirtual

calculates the force on the geometry nodes

Parameters
nodesthe nodes where the force is applied

Implements LbmLib::solver::AbstractForceStruct.

Definition at line 207 of file ForceStructs.hpp.

unsigned int LbmLib::solver::ForceStructs::ForceType2::getPartnerGeometryNode ( void  ) const
inlinevirtual

getPartnerGeometryNode

Returns
Shall return 0 if there is no partner node, or its nodeID otherwise.

Implements LbmLib::solver::AbstractForceStruct.

Definition at line 220 of file ForceStructs.hpp.

unsigned int LbmLib::solver::ForceStructs::ForceType2::getType ( ) const
inlinevirtual

Returns the force type.

Returns
The force type.

Implements LbmLib::solver::AbstractForceStruct.

Definition at line 216 of file ForceStructs.hpp.

void LbmLib::solver::ForceStructs::ForceType2::writeForceStruct ( std::ofstream *const  stream) const
inlinevirtual

writes the force struct to the ostream

Parameters
streamthe output stream

Implements LbmLib::solver::AbstractForceStruct.

Definition at line 212 of file ForceStructs.hpp.


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