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

Base class for function objects that refer to a cloud. Provides hooks into the cloud solution process. Not a function object in itself. Must be mixed in. More...

Inheritance diagram for cloudFunctionObject:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("cloudFunctionObject")
 Runtime type information. More...
 
 cloudFunctionObject (const LagrangianMeshFunctionObject &)
 Construct from a Lagrangian mesh function object. More...
 
 cloudFunctionObject (const fvMeshFunctionObject &, const dictionary &dict)
 Construct from an fvMesh function object and a dictionary. More...
 
 cloudFunctionObject (const cloudFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~cloudFunctionObject ()
 Destructor. More...
 
const Foam::cloud & cloud () const
 Return the cloud. More...
 
virtual void preSolve ()
 Hook before solution steps. More...
 
virtual void calculate (const LagrangianSubScalarField &deltaT, const bool final)
 Solve equations and/or update continually changing properties. More...
 
virtual void preCrossFaces (const LagrangianScalarInternalDynamicField &fraction)
 Hook before all face crossings. More...
 
virtual void preCrossFaces (const LagrangianSubScalarSubField &fraction)
 Hook before face crossings of a specific sub-mesh. More...
 
virtual void postCrossFaces (const LagrangianSubScalarSubField &fraction)
 Hook following face crossings of a specific sub-mesh. More...
 
virtual void postCrossFaces (const LagrangianScalarInternalDynamicField &fraction)
 Hook after all face crossings. More...
 
virtual void postSolve ()
 Hook following solution steps. More...
 
void operator= (const cloudFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 

Protected Member Functions

template<class Cloud >
bool isCloud () const
 Determine whether the cloud is of the given type. More...
 
template<class Cloud = Foam::cloud>
const Cloud & cloud () const
 Get a reference to the cloud. More...
 

Detailed Description

Base class for function objects that refer to a cloud. Provides hooks into the cloud solution process. Not a function object in itself. Must be mixed in.

Source files

Definition at line 58 of file cloudFunctionObject.H.

Constructor & Destructor Documentation

◆ cloudFunctionObject() [1/3]

cloudFunctionObject ( const LagrangianMeshFunctionObject &  function)

Construct from a Lagrangian mesh function object.

Definition at line 45 of file cloudFunctionObject.C.

◆ cloudFunctionObject() [2/3]

cloudFunctionObject ( const fvMeshFunctionObject &  function,
const dictionary &  dict 
)

Construct from an fvMesh function object and a dictionary.

Definition at line 58 of file cloudFunctionObject.C.

◆ cloudFunctionObject() [3/3]

cloudFunctionObject ( const cloudFunctionObject &  )
delete

Disallow default bitwise copy construction.

◆ ~cloudFunctionObject()

~cloudFunctionObject ( )
virtual

Destructor.

Definition at line 77 of file cloudFunctionObject.C.

Member Function Documentation

◆ isCloud()

bool isCloud
protected

Determine whether the cloud is of the given type.

Definition at line 32 of file cloudFunctionObjectTemplates.C.

◆ cloud() [1/2]

const Cloud & cloud
protected

Get a reference to the cloud.

Definition at line 39 of file cloudFunctionObjectTemplates.C.

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

Referenced by cloudFunctionObjectUList::cloudFunctionObjectUList().

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

◆ TypeName()

TypeName ( "cloudFunctionObject"  )

Runtime type information.

◆ cloud() [2/2]

const Foam::cloud & cloud ( ) const

Return the cloud.

Definition at line 83 of file cloudFunctionObject.C.

◆ preSolve()

void preSolve ( )
virtual

Hook before solution steps.

Reimplemented in cloudLagrangianVolumeFraction, cloudKineticEnergy, cloudGravitationalPotentialEnergy, cloudFlux, and cloudBoundaryCollisionFlux.

Definition at line 89 of file cloudFunctionObject.C.

Referenced by cloudFunctionObjectUList::cloudFunctionObjectUList().

Here is the caller graph for this function:

◆ calculate()

void calculate ( const LagrangianSubScalarField &  deltaT,
const bool  final 
)
virtual

Solve equations and/or update continually changing properties.

Reimplemented in cloudVolume, cloudSurfaceArea, cloudMass, and cloudAge.

Definition at line 93 of file cloudFunctionObject.C.

◆ preCrossFaces() [1/2]

void preCrossFaces ( const LagrangianScalarInternalDynamicField &  fraction)
virtual

Hook before all face crossings.

Reimplemented in cloudSurfaceDistribution, cloudFlux, cloudBoundaryCollisionFlux, and cloudBoundaryCollisionFlux.

Definition at line 101 of file cloudFunctionObject.C.

◆ preCrossFaces() [2/2]

virtual void preCrossFaces ( const LagrangianSubScalarSubField &  fraction)
virtual

Hook before face crossings of a specific sub-mesh.

Reimplemented in cloudSurfaceDistribution, cloudFlux, cloudBoundaryCollisionFlux, and cloudBoundaryCollisionFlux.

◆ postCrossFaces() [1/2]

void postCrossFaces ( const LagrangianSubScalarSubField &  fraction)
virtual

Hook following face crossings of a specific sub-mesh.

Reimplemented in cloudSurfaceDistribution, cloudFlux, cloudBoundaryCollisionFlux, and cloudBoundaryCollisionFlux.

Definition at line 115 of file cloudFunctionObject.C.

◆ postCrossFaces() [2/2]

virtual void postCrossFaces ( const LagrangianScalarInternalDynamicField &  fraction)
virtual

Hook after all face crossings.

Reimplemented in cloudSurfaceDistribution, cloudFlux, cloudBoundaryCollisionFlux, and cloudBoundaryCollisionFlux.

◆ postSolve()

void postSolve ( )
virtual

Hook following solution steps.

Definition at line 129 of file cloudFunctionObject.C.

◆ operator=()

void operator= ( const cloudFunctionObject &  )
delete

Disallow default bitwise assignment.

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