Public Member Functions | Protected Member Functions | List of all members
cloudLagrangianModel Class Reference

Base class for Lagrangian models that refer to a cloud. Not a Lagrangian model in itself. Must be mixed in. More...

Inheritance diagram for cloudLagrangianModel:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("cloudLagrangianModel")
 Runtime type information. More...
 
 cloudLagrangianModel (const LagrangianModel &)
 Construct from a Lagrangian model. More...
 
virtual ~cloudLagrangianModel ()
 Destructor. More...
 

Protected Member Functions

template<class Cloud , class ... Clouds>
bool isCloud () const
 Determine whether the cloud is one of the given types. More...
 
template<class Cloud , class ... Clouds>
void assertCloud () const
 Generate an error if the cloud is not one of the given types. More...
 
template<class Cloud = Foam::cloud>
const Cloud & cloud () const
 Get a reference to the cloud. More...
 

Detailed Description

Base class for Lagrangian models that refer to a cloud. Not a Lagrangian model in itself. Must be mixed in.

Source files

Definition at line 51 of file cloudLagrangianModel.H.

Constructor & Destructor Documentation

◆ cloudLagrangianModel()

cloudLagrangianModel ( const LagrangianModel &  model)

Construct from a Lagrangian model.

Definition at line 38 of file cloudLagrangianModel.C.

◆ ~cloudLagrangianModel()

~cloudLagrangianModel ( )
virtual

Destructor.

Definition at line 47 of file cloudLagrangianModel.C.

Member Function Documentation

◆ isCloud()

bool isCloud
protected

Determine whether the cloud is one of the given types.

Definition at line 33 of file cloudLagrangianModelTemplates.C.

References Foam::isA().

Here is the call graph for this function:

◆ assertCloud()

void assertCloud
protected

Generate an error if the cloud is not one of the given types.

Definition at line 40 of file cloudLagrangianModelTemplates.C.

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

Here is the call graph for this function:

◆ cloud()

const Cloud & cloud
protected

Get a reference to the cloud.

Definition at line 55 of file cloudLagrangianModelTemplates.C.

Referenced by turbulentDispersion::initialiseTurbField().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "cloudLagrangianModel"  )

Runtime type information.

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