LBIBCell
 All Classes Functions Variables Friends Pages
Public Member Functions | List of all members
LbmLib::solver::AbstractForceStruct Struct Referenceabstract

the base class for all forces More...

#include <AbstractForceStruct.hpp>

Inheritance diagram for LbmLib::solver::AbstractForceStruct:
LbmLib::solver::ForceStructs::ForceType0 LbmLib::solver::ForceStructs::ForceType1 LbmLib::solver::ForceStructs::ForceType2 LbmLib::solver::ForceStructs::ForceType3 LbmLib::solver::ForceStructs::ForceType4 LbmLib::solver::ForceStructs::ForceType5 LbmLib::solver::ForceStructs::ForceType6 LbmLib::solver::ForceStructs::ForceType7

Public Member Functions

virtual void calculateForce (const std::map< unsigned int, std::shared_ptr< nodes::GeometryNode > > &nodes)=0
 calculates the force on the geometry nodes More...
 
virtual ~AbstractForceStruct ()
 Destructor.
 
virtual void writeForceStruct (std::ofstream *const stream) const =0
 writes the force struct to the ostream More...
 
virtual unsigned int getType (void) const =0
 Returns the force type. More...
 
virtual unsigned int getPartnerGeometryNode (void) const =0
 getPartnerGeometryNode More...
 

Detailed Description

the base class for all forces

Definition at line 39 of file AbstractForceStruct.hpp.

Member Function Documentation

virtual void LbmLib::solver::AbstractForceStruct::calculateForce ( const std::map< unsigned int, std::shared_ptr< nodes::GeometryNode > > &  nodes)
pure virtual

calculates the force on the geometry nodes

Parameters
nodesthe nodes where the force is applied

Implemented in LbmLib::solver::ForceStructs::ForceType7, LbmLib::solver::ForceStructs::ForceType6, LbmLib::solver::ForceStructs::ForceType5, LbmLib::solver::ForceStructs::ForceType4, LbmLib::solver::ForceStructs::ForceType3, LbmLib::solver::ForceStructs::ForceType2, LbmLib::solver::ForceStructs::ForceType1, and LbmLib::solver::ForceStructs::ForceType0.

virtual unsigned int LbmLib::solver::AbstractForceStruct::getPartnerGeometryNode ( void  ) const
pure virtual

getPartnerGeometryNode

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

Implemented in LbmLib::solver::ForceStructs::ForceType7, LbmLib::solver::ForceStructs::ForceType6, LbmLib::solver::ForceStructs::ForceType5, LbmLib::solver::ForceStructs::ForceType4, LbmLib::solver::ForceStructs::ForceType3, LbmLib::solver::ForceStructs::ForceType2, LbmLib::solver::ForceStructs::ForceType1, and LbmLib::solver::ForceStructs::ForceType0.

virtual unsigned int LbmLib::solver::AbstractForceStruct::getType ( void  ) const
pure virtual

Returns the force type.

Returns
The force type.

Implemented in LbmLib::solver::ForceStructs::ForceType7, LbmLib::solver::ForceStructs::ForceType6, LbmLib::solver::ForceStructs::ForceType5, LbmLib::solver::ForceStructs::ForceType4, LbmLib::solver::ForceStructs::ForceType3, LbmLib::solver::ForceStructs::ForceType2, LbmLib::solver::ForceStructs::ForceType1, and LbmLib::solver::ForceStructs::ForceType0.

virtual void LbmLib::solver::AbstractForceStruct::writeForceStruct ( std::ofstream *const  stream) const
pure virtual

writes the force struct to the ostream

Parameters
streamthe output stream

Implemented in LbmLib::solver::ForceStructs::ForceType7, LbmLib::solver::ForceStructs::ForceType6, LbmLib::solver::ForceStructs::ForceType5, LbmLib::solver::ForceStructs::ForceType4, LbmLib::solver::ForceStructs::ForceType3, LbmLib::solver::ForceStructs::ForceType2, LbmLib::solver::ForceStructs::ForceType1, and LbmLib::solver::ForceStructs::ForceType0.

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