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

a spring force between a node and a horzontal slider (sliding at hight y) More...

#include <ForceStructs.hpp>

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

Public Member Functions

 ForceType3 (unsigned int id1, double y, double k, double l0)
 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 spring force between a node and a horzontal slider (sliding at hight y)

Definition at line 248 of file ForceStructs.hpp.

Constructor & Destructor Documentation

LbmLib::solver::ForceStructs::ForceType3::ForceType3 ( unsigned int  id1,
double  y,
double  k,
double  l0 
)
inline

the constructor of this force

Parameters
id1the id of the node where the force is applied
yThe y position of the horizontal slider.
kthe spring constant
l0the default distance

Definition at line 256 of file ForceStructs.hpp.

Member Function Documentation

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

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

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

Returns the force type.

Returns
The force type.

Implements LbmLib::solver::AbstractForceStruct.

Definition at line 286 of file ForceStructs.hpp.

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


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