Loading...
Searching...
No Matches
forceCoeffs::coeffDesc Struct Reference

Coefficients description. More...

#include <forceCoeffs.H>

Collaboration diagram for forceCoeffs::coeffDesc:
Collaboration graph
[legend]

Public Types

enum  splitType { stFront , stRear , stNone }

Public Member Functions

 coeffDesc (const string &description, const word &name, const label c0, const label c1=-1)
 Construct from components.
const word frontName () const noexcept
 Return name with front-name appendix.
const word rearName () const noexcept
 Return name with rear-name appendix.
void print (Ostream &os) const
 Print description.
vector value (const forceComponents &f, const forceComponents &m) const
 Return force/moment components based on the specified split type.
coeffDesc front () const
 Return front-axle coefficient description.
coeffDesc rear () const
 Return rear-axle coefficient description.

Public Attributes

string desc_
word name_
label c0_
label c1_
bool active_
splitType splitType_

Detailed Description

Coefficients description.

Definition at line 527 of file forceCoeffs.H.

Member Enumeration Documentation

◆ splitType

enum splitType
Enumerator
stFront 
stRear 
stNone 

Definition at line 529 of file forceCoeffs.H.

Constructor & Destructor Documentation

◆ coeffDesc()

coeffDesc ( const string & description,
const word & name,
const label c0,
const label c1 = -1 )
inline

Construct from components.

Definition at line 548 of file forceCoeffs.H.

References active_, c0_, c1_, desc_, Foam::name(), name_, splitType_, and stNone.

Referenced by front(), and rear().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ frontName()

const word frontName ( ) const
inlinenoexcept

Return name with front-name appendix.

Definition at line 567 of file forceCoeffs.H.

References name_, and Foam::noexcept.

Referenced by front().

Here is the caller graph for this function:

◆ rearName()

const word rearName ( ) const
inlinenoexcept

Return name with rear-name appendix.

Definition at line 575 of file forceCoeffs.H.

References name_, and Foam::noexcept.

Referenced by rear().

Here is the caller graph for this function:

◆ print()

void print ( Ostream & os) const
inline

Print description.

Definition at line 583 of file forceCoeffs.H.

References desc_, name_, and os().

Here is the call graph for this function:

◆ value()

vector value ( const forceComponents & f,
const forceComponents & m ) const
inline

Return force/moment components based on the specified split type.

Definition at line 591 of file forceCoeffs.H.

References Foam::abort(), c0_, c1_, f(), Foam::FatalError, FatalErrorInFunction, splitType_, stFront, stNone, stRear, and VectorSpace< Form, Cmpt, Ncmpts >::zero.

Here is the call graph for this function:

◆ front()

coeffDesc front ( ) const
inline

Return front-axle coefficient description.

Definition at line 626 of file forceCoeffs.H.

References coeffDesc(), desc_, frontName(), name_, splitType_, and stFront.

Here is the call graph for this function:

◆ rear()

coeffDesc rear ( ) const
inline

Return rear-axle coefficient description.

Definition at line 638 of file forceCoeffs.H.

References coeffDesc(), desc_, name_, rearName(), splitType_, and stRear.

Here is the call graph for this function:

Member Data Documentation

◆ desc_

string desc_

Definition at line 536 of file forceCoeffs.H.

Referenced by coeffDesc(), front(), print(), and rear().

◆ name_

word name_

Definition at line 537 of file forceCoeffs.H.

Referenced by coeffDesc(), front(), frontName(), print(), rear(), and rearName().

◆ c0_

label c0_

Definition at line 538 of file forceCoeffs.H.

Referenced by coeffDesc(), and value().

◆ c1_

label c1_

Definition at line 539 of file forceCoeffs.H.

Referenced by coeffDesc(), and value().

◆ active_

bool active_

Definition at line 540 of file forceCoeffs.H.

Referenced by coeffDesc().

◆ splitType_

splitType splitType_

Definition at line 541 of file forceCoeffs.H.

Referenced by coeffDesc(), front(), rear(), and value().

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