LagrangianModelRef Class Reference

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

Public Member Functions

 LagrangianModelRef ()
 Construct null. More...
 
 LagrangianModelRef (const LagrangianModel &ref)
 Construct for given reference. More...
 
bool valid () const
 Check if the reference is valid. More...
 
const LagrangianModel & operator() () const
 Access the reference. More...
 

Detailed Description

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

Source files

Definition at line 48 of file LagrangianModelRef.H.

Constructor & Destructor Documentation

◆ LagrangianModelRef() [1/2]

LagrangianModelRef ( )
inline

Construct null.

Definition at line 32 of file LagrangianModelRefI.H.

◆ LagrangianModelRef() [2/2]

LagrangianModelRef ( const LagrangianModel &  ref)
inline

Construct for given reference.

Definition at line 38 of file LagrangianModelRefI.H.

Member Function Documentation

◆ valid()

bool valid ( ) const
inline

Check if the reference is valid.

Definition at line 46 of file LagrangianModelRefI.H.

References Foam::notNull().

Here is the call graph for this function:

◆ operator()()

const Foam::LagrangianModel & operator() ( ) const
inline

Access the reference.

Definition at line 54 of file LagrangianModelRefI.H.

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

Here is the call graph for this function:

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