Public Member Functions | Protected Member Functions | List of all members
CloudLagrangianFieldSource< Type > Class Template Reference

Templated base class for source conditions that refer to a cloud. Not a source condition in itself. Must be mixed in. More...

Inheritance diagram for CloudLagrangianFieldSource< Type >:
Inheritance graph
[legend]

Public Member Functions

template<class Derived >
 CloudLagrangianFieldSource (const Derived &)
 Construct with reference to the derived field source. 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 LagrangianModel &model, const LagrangianSubMesh &subMesh) const
 Generate an error if the cloud is not one of the given types. More...
 
template<class Cloud = Foam::cloud>
const Cloud & cloud (const LagrangianModel &model, const LagrangianSubMesh &subMesh) const
 Get a reference to the cloud. More...
 

Detailed Description

template<class Type>
class Foam::CloudLagrangianFieldSource< Type >

Templated base class for source conditions that refer to a cloud. Not a source condition in itself. Must be mixed in.

Source files

Definition at line 54 of file CloudLagrangianFieldSource.H.

Constructor & Destructor Documentation

◆ CloudLagrangianFieldSource()

CloudLagrangianFieldSource ( const Derived &  field)

Construct with reference to the derived field source.

Definition at line 35 of file CloudLagrangianFieldSource.C.

Member Function Documentation

◆ isCloud()

bool isCloud
protected

Determine whether the cloud is one of the given types.

Definition at line 49 of file CloudLagrangianFieldSource.C.

References Foam::isA().

Here is the call graph for this function:

◆ assertCloud()

void assertCloud ( const LagrangianModel &  model,
const LagrangianSubMesh &  subMesh 
) const
protected

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

Definition at line 57 of file CloudLagrangianFieldSource.C.

References FatalErrorInFunction, and LagrangianModel::name().

Here is the call graph for this function:

◆ cloud()

const Cloud & cloud ( const LagrangianModel &  model,
const LagrangianSubMesh &  subMesh 
) const
protected

Get a reference to the cloud.

Definition at line 80 of file CloudLagrangianFieldSource.C.

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