Public Member Functions | List of all members
LagrangianModelRef Class Reference

Simple wrapper to provide an optional reference to a Lagrangian model. More...

Public Member Functions

 LagrangianModelRef ()
 Construct null. More...
 
 LagrangianModelRef (const LagrangianSource &source, const LagrangianSubScalarField &S)
 Construct for a source. More...
 
 LagrangianModelRef (const LagrangianInjection &injection)
 Construct for an injection. More...
 
bool isSource () const
 Check if the source reference is valid. More...
 
const LagrangianSource & source () const
 Access the source model. More...
 
const LagrangianSubScalarField & S () const
 Access the source field. More...
 
bool isInjection () const
 Check if the injection reference is valid. More...
 
const LagrangianInjection & injection () const
 Access the injection model. More...
 

Detailed Description

Simple wrapper to provide an optional reference to a Lagrangian model.

Source files

Definition at line 51 of file LagrangianModelRef.H.

Constructor & Destructor Documentation

◆ LagrangianModelRef() [1/3]

LagrangianModelRef ( )
inline

Construct null.

Definition at line 30 of file LagrangianModelRefI.H.

◆ LagrangianModelRef() [2/3]

LagrangianModelRef ( const LagrangianSource &  source,
const LagrangianSubScalarField &  S 
)
inline

Construct for a source.

Definition at line 38 of file LagrangianModelRefI.H.

◆ LagrangianModelRef() [3/3]

LagrangianModelRef ( const LagrangianInjection &  injection)
inline

Construct for an injection.

Definition at line 50 of file LagrangianModelRefI.H.

Member Function Documentation

◆ isSource()

bool isSource ( ) const
inline

Check if the source reference is valid.

Definition at line 63 of file LagrangianModelRefI.H.

References Foam::notNull().

Referenced by CloudStateFieldRef< Type >::operator()().

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

◆ source()

const Foam::LagrangianSource & source ( ) const
inline

Access the source model.

Definition at line 70 of file LagrangianModelRefI.H.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by CloudStateFieldRef< Type >::operator()().

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

◆ S()

const Foam::LagrangianSubScalarField & S ( ) const
inline

Access the source field.

Definition at line 84 of file LagrangianModelRefI.H.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ isInjection()

bool isInjection ( ) const
inline

Check if the injection reference is valid.

Definition at line 97 of file LagrangianModelRefI.H.

References Foam::notNull().

Referenced by CloudStateFieldRef< Type >::operator()().

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

◆ injection()

const Foam::LagrangianInjection & injection ( ) const
inline

Access the injection model.

Definition at line 104 of file LagrangianModelRefI.H.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by CloudStateFieldRef< Type >::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: