Public Types | Public Member Functions | Public Attributes | List of all members
forceCoeffs::coeffDesc Struct Reference
Collaboration diagram for forceCoeffs::coeffDesc:
[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. More...
 
const word frontName () const noexcept
 Return name with front-name appendix. More...
 
const word rearName () const noexcept
 Return name with rear-name appendix. More...
 
vector value (const forceComponents &f, const forceComponents &m) const
 Return force/moment components based on the specified split type. More...
 
coeffDesc front () const
 Return front-axle coefficient description. More...
 
coeffDesc rear () const
 Return rear-axle coefficient description. More...
 

Public Attributes

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

Detailed Description

Definition at line 514 of file forceCoeffs.H.

Member Enumeration Documentation

◆ splitType

enum splitType
Enumerator
stFront 
stRear 
stNone 

Definition at line 516 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 533 of file forceCoeffs.H.

Member Function Documentation

◆ frontName()

const word frontName ( ) const
inlinenoexcept

Return name with front-name appendix.

Definition at line 550 of file forceCoeffs.H.

References forceCoeffs::coeffDesc::name_.

Referenced by forceCoeffs::coeffDesc::front().

Here is the caller graph for this function:

◆ rearName()

const word rearName ( ) const
inlinenoexcept

Return name with rear-name appendix.

Definition at line 556 of file forceCoeffs.H.

References forceCoeffs::coeffDesc::name_.

Referenced by forceCoeffs::coeffDesc::rear().

Here is the caller 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 562 of file forceCoeffs.H.

References forceCoeffs::coeffDesc::c0_, forceCoeffs::coeffDesc::c1_, f(), Foam::FatalError, FatalErrorInFunction, forceCoeffs::coeffDesc::splitType_, forceCoeffs::coeffDesc::stFront, forceCoeffs::coeffDesc::stNone, and forceCoeffs::coeffDesc::stRear.

Here is the call graph for this function:

◆ front()

coeffDesc front ( ) const
inline

Return front-axle coefficient description.

Definition at line 595 of file forceCoeffs.H.

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

Here is the call graph for this function:

◆ rear()

coeffDesc rear ( ) const
inline

Return rear-axle coefficient description.

Definition at line 605 of file forceCoeffs.H.

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

Here is the call graph for this function:

Member Data Documentation

◆ desc_

string desc_

Definition at line 523 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::front(), Foam::functionObjects::operator<<(), and forceCoeffs::coeffDesc::rear().

◆ name_

word name_

Definition at line 524 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::front(), forceCoeffs::coeffDesc::frontName(), Foam::functionObjects::operator<<(), forceCoeffs::coeffDesc::rear(), and forceCoeffs::coeffDesc::rearName().

◆ c0_

label c0_

Definition at line 525 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::value().

◆ c1_

label c1_

Definition at line 526 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::value().

◆ active_

bool active_

Definition at line 527 of file forceCoeffs.H.

◆ splitType_

splitType splitType_

Definition at line 528 of file forceCoeffs.H.

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

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