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

a constant force between 2 nodes More...

#include <ForceStructs.hpp>

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

Public Member Functions

 ForceType6 (unsigned int id1, unsigned int id2, double f)
 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 constant force between 2 nodes

Attention
The force is ony applied to id1. To get the reaction, add the force with switched ids.

Definition at line 455 of file ForceStructs.hpp.

Constructor & Destructor Documentation

LbmLib::solver::ForceStructs::ForceType6::ForceType6 ( unsigned int  id1,
unsigned int  id2,
double  f 
)
inline

the constructor of this force

Parameters
id1the id of the first node
id2the id of the second node
fthe constant force

Definition at line 462 of file ForceStructs.hpp.

Member Function Documentation

void LbmLib::solver::ForceStructs::ForceType6::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 470 of file ForceStructs.hpp.

unsigned int LbmLib::solver::ForceStructs::ForceType6::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 493 of file ForceStructs.hpp.

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

Returns the force type.

Returns
The force type.

Implements LbmLib::solver::AbstractForceStruct.

Definition at line 489 of file ForceStructs.hpp.

void LbmLib::solver::ForceStructs::ForceType6::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 485 of file ForceStructs.hpp.


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