forceCoeffs::forceComponents Class Reference

Public Member Functions

 forceComponents ()
 Default construct. More...
 
const vector total () const noexcept
 Return the sum of the components. More...
 
void reset () noexcept
 Reset the components to zero. More...
 
void reset (const vector &pressure, const vector &viscous, const vector &internal) noexcept
 Reset the components to given values. More...
 
vector operator[] (const label cmpt) const
 Return components in a given direction. More...
 

Detailed Description

Definition at line 440 of file forceCoeffs.H.

Constructor & Destructor Documentation

◆ forceComponents()

forceComponents ( )
inline

Default construct.

Definition at line 467 of file forceCoeffs.H.

Member Function Documentation

◆ total()

const vector total ( ) const
inlinenoexcept

Return the sum of the components.

Definition at line 480 of file forceCoeffs.H.

◆ reset() [1/2]

void reset ( )
inlinenoexcept

Reset the components to zero.

Definition at line 488 of file forceCoeffs.H.

References Foam::Zero.

◆ reset() [2/2]

void reset ( const vector pressure,
const vector viscous,
const vector internal 
)
inlinenoexcept

Reset the components to given values.

Definition at line 499 of file forceCoeffs.H.

◆ operator[]()

vector operator[] ( const label  cmpt) const
inline

Return components in a given direction.

Definition at line 516 of file forceCoeffs.H.


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