Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
coupled Class Referenceabstract

Base class for clouds which are coupled to a fluid. More...

Inheritance diagram for coupled:
Inheritance graph
[legend]
Collaboration diagram for coupled:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("coupled")
 Run-time type information. More...
 
 coupled (const cloud &c)
 Construct from a reference to the cloud. More...
 
virtual ~coupled ()
 Destructor. More...
 
template<class Type >
const CarrierField< Type > & carrierField (const VolField< Type > &) const
 Add/get a carrier field to/from the cache. More...
 
template<class Type , class ... Args>
const CarrierField< Type > & carrierField (const Args &... args) const
 Add/get a carrier field to/from the cache. More...
 
template<class Type >
CarrierEqn< Type > & carrierEqn (const VolField< Type > &)
 Add/get a carrier equation to/from the cache. More...
 
template<class Type >
const CarrierEqn< Type > & carrierEqn (const VolField< Type > &) const
 Add/get a carrier equation to/from the cache. More...
 
template<class Type >
CarrierEqn< Type > & carrierEqn (const CarrierField< Type > &)
 Add/get a carrier equation to/from the cache. More...
 
template<class Type >
const CarrierEqn< Type > & carrierEqn (const CarrierField< Type > &) const
 Add/get a carrier equation to/from the cache. More...
 
template<class Type >
const Foam::CarrierField< Type > & carrierField (const VolField< Type > &psi) const
 
template<class Type , class ... Args>
const Foam::CarrierField< Type > & carrierField (const Args &... args) const
 
template<class Type >
Foam::CarrierEqn< Type > & carrierEqn (const VolField< Type > &psi)
 
template<class Type >
const Foam::CarrierEqn< Type > & carrierEqn (const VolField< Type > &psi) const
 
template<class Type >
Foam::CarrierEqn< Type > & carrierEqn (const CarrierField< Type > &psic)
 
template<class Type >
const Foam::CarrierEqn< Type > & carrierEqn (const CarrierField< Type > &psic) const
 

Static Public Member Functions

static word carrierName (const word &name)
 Modify a name to disambiguate it as relating to the carrier. More...
 

Public Attributes

const CarrierField< vector > & Uc
 Carrier velocity. More...
 
const CarrierField< vector > & curlUc
 Carrier velocity curl. More...
 
const CarrierField< vector > & DUDtc
 Carrier advective derivative. More...
 
const CloudDerivedField< scalar > & nuc
 Carrier kinematic viscosity. More...
 

Protected Member Functions

void clearCarrierEqns ()
 Clear the carrier equations. More...
 
void initialise (const bool predict)
 Initialisation hook. More...
 
void partition ()
 Partition hook. More...
 

Detailed Description

Base class for clouds which are coupled to a fluid.

Source files

Definition at line 59 of file coupled.H.

Constructor & Destructor Documentation

◆ coupled()

coupled ( const cloud &  c)

Construct from a reference to the cloud.

Definition at line 202 of file coupled.C.

References Foam::fvc::curl(), and coupled::Uc.

Here is the call graph for this function:

◆ ~coupled()

~coupled ( )
virtual

Destructor.

Definition at line 240 of file coupled.C.

Member Function Documentation

◆ clearCarrierEqns()

void clearCarrierEqns ( )
protected

Clear the carrier equations.

Definition at line 171 of file coupled.C.

References CLEAR_TYPE_CARRIER_EQNS, and Foam::FOR_ALL_FIELD_TYPES().

Referenced by kinematicParcel::solve(), kinematicParticle::solve(), parcel::solve(), and particle::solve().

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

◆ initialise()

void initialise ( const bool  predict)
protected

Initialisation hook.

Definition at line 188 of file coupled.C.

Referenced by kinematicParcel::initialise(), kinematicParticle::initialise(), parcel::initialise(), and particle::initialise().

Here is the caller graph for this function:

◆ partition()

void partition ( )
protected

Partition hook.

Definition at line 194 of file coupled.C.

Referenced by kinematicParcel::partition(), kinematicParticle::partition(), parcel::partition(), and particle::partition().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "coupled"  )

Run-time type information.

◆ carrierName()

Foam::word carrierName ( const word &  name)
static

Modify a name to disambiguate it as relating to the carrier.

Definition at line 246 of file coupled.C.

References IOobject::group(), IOobject::groupName(), IOobject::member(), and Foam::name().

Referenced by totalPressureVelocityLagrangianVectorFieldSource::write().

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

◆ carrierField() [1/4]

const CarrierField<Type>& carrierField ( const VolField< Type > &  ) const

Add/get a carrier field to/from the cache.

◆ carrierField() [2/4]

const CarrierField<Type>& carrierField ( const Args &...  args) const

Add/get a carrier field to/from the cache.

◆ carrierEqn() [1/8]

CarrierEqn<Type>& carrierEqn ( const VolField< Type > &  )

Add/get a carrier equation to/from the cache.

◆ carrierEqn() [2/8]

const CarrierEqn<Type>& carrierEqn ( const VolField< Type > &  ) const

Add/get a carrier equation to/from the cache.

◆ carrierEqn() [3/8]

CarrierEqn<Type>& carrierEqn ( const CarrierField< Type > &  )

Add/get a carrier equation to/from the cache.

◆ carrierEqn() [4/8]

const CarrierEqn<Type>& carrierEqn ( const CarrierField< Type > &  ) const

Add/get a carrier equation to/from the cache.

◆ carrierField() [3/4]

const Foam::CarrierField<Type>& carrierField ( const VolField< Type > &  psi) const

Definition at line 33 of file coupledTemplates.C.

References psi.

◆ carrierField() [4/4]

const Foam::CarrierField<Type>& carrierField ( const Args &...  args) const

Definition at line 43 of file coupledTemplates.C.

References args, CarrierField< Type >::name(), and Foam::name().

Here is the call graph for this function:

◆ carrierEqn() [5/8]

Foam::CarrierEqn<Type>& carrierEqn ( const VolField< Type > &  psi)

Definition at line 60 of file coupledTemplates.C.

References psi.

◆ carrierEqn() [6/8]

const Foam::CarrierEqn<Type>& carrierEqn ( const VolField< Type > &  psi) const

Definition at line 77 of file coupledTemplates.C.

References psi.

◆ carrierEqn() [7/8]

Foam::CarrierEqn<Type>& carrierEqn ( const CarrierField< Type > &  psic)

Definition at line 87 of file coupledTemplates.C.

References CarrierField< Type >::psi().

Here is the call graph for this function:

◆ carrierEqn() [8/8]

const Foam::CarrierEqn<Type>& carrierEqn ( const CarrierField< Type > &  psic) const

Definition at line 97 of file coupledTemplates.C.

References CarrierField< Type >::psi().

Here is the call graph for this function:

Member Data Documentation

◆ Uc

const CarrierField<vector>& Uc

Carrier velocity.

Definition at line 138 of file coupled.H.

Referenced by coupled::coupled(), and sphericalCoupled::sphericalCoupled().

◆ curlUc

const CarrierField<vector>& curlUc

Carrier velocity curl.

Definition at line 141 of file coupled.H.

◆ DUDtc

const CarrierField<vector>& DUDtc

Carrier advective derivative.

Definition at line 144 of file coupled.H.

◆ nuc

const CloudDerivedField<scalar>& nuc

Carrier kinematic viscosity.

Definition at line 147 of file coupled.H.

Referenced by sphericalCoupled::sphericalCoupled().

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