Public Member Functions | List of all members
cloudLagrangianFieldSource Class Reference

Mix-in for source conditions that refer to a cloud. More...

Inheritance diagram for cloudLagrangianFieldSource:
Inheritance graph
[legend]

Public Member Functions

template<class Derived >
 cloudLagrangianFieldSource (const Derived &)
 Construct with reference to the derived field source. More...
 
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 , class ... Clouds>
void assertCloud (const LagrangianModel &model) 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...
 
template<class Cloud = Foam::cloud>
const Cloud & cloud (const LagrangianModel &model) const
 Get a reference to the cloud. More...
 

Detailed Description

Mix-in for source conditions that refer to a cloud.

Source files

Definition at line 53 of file cloudLagrangianFieldSource.H.

Constructor & Destructor Documentation

◆ cloudLagrangianFieldSource()

cloudLagrangianFieldSource ( const Derived &  field)

Construct with reference to the derived field source.

Definition at line 34 of file cloudLagrangianFieldSourceTemplates.C.

Member Function Documentation

◆ isCloud()

bool isCloud

Determine whether the cloud is one of the given types.

Definition at line 52 of file cloudLagrangianFieldSourceTemplates.C.

References Foam::isA(), and Foam::isNull().

Here is the call graph for this function:

◆ assertCloud() [1/2]

void assertCloud

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

Definition at line 66 of file cloudLagrangianFieldSourceTemplates.C.

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

Here is the call graph for this function:

◆ assertCloud() [2/2]

void assertCloud ( const LagrangianModel &  model) const

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

Definition at line 83 of file cloudLagrangianFieldSourceTemplates.C.

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

Here is the call graph for this function:

◆ cloud() [1/2]

const Cloud & cloud

Get a reference to the cloud.

Definition at line 104 of file cloudLagrangianFieldSourceTemplates.C.

◆ cloud() [2/2]

const Cloud & cloud ( const LagrangianModel &  model) const

Get a reference to the cloud.

Definition at line 113 of file cloudLagrangianFieldSourceTemplates.C.

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