coupledToConstantDensityFluid Class Reference

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

Inheritance diagram for coupledToConstantDensityFluid:
Collaboration diagram for coupledToConstantDensityFluid:

Public Member Functions

 TypeName ("coupledToConstantDensityFluid")
 Run-time type information. More...
 
 coupledToConstantDensityFluid (const cloud &c, const carried &)
 Construct from a reference to the cloud. More...
 
virtual ~coupledToConstantDensityFluid ()
 Destructor. More...
 
const dimensionedScalarrho () const
 Cloud density. More...
 
const dimensionedScalarrhoc () const
 Carrier density. More...
 
const dimensionedScalarrhocPhase () const
 Corresponding Eulerian phase density. More...
 
- Public Member Functions inherited from coupled
 TypeName ("coupled")
 Run-time type information. More...
 
 coupled (const cloud &c, const carried &)
 Construct from a reference to the cloud. More...
 
virtual ~coupled ()
 Destructor. More...
 
bool hasCarrierEqns () const
 Return if any carrier equations are cached. More...
 
template<class Type >
bool hasCarrierEqn (const word &) const
 Return if a carrier equation is in the cache. More...
 
template<class Type >
const CarrierEqn< Type > & carrierEqn (const word &) const
 Get a carrier equation from the cache. More...
 
template<class Type >
const HashTable< const CarrierEqn< Type > * > carrierEqns (const word &) const
 Get multiple phase carrier equations from the cache. More...
 
template<class Type >
bool hasCarrierEqn (const VolField< Type > &) const
 Return if a carrier equation is in the cache. More...
 
template<class Type >
const CarrierEqn< Type > & carrierEqn (const VolField< Type > &) const
 Get a carrier equation from the cache. More...
 
template<class Type >
const HashTable< const CarrierEqn< Type > * > carrierEqns (const VolField< Type > &) const
 Get multiple phase carrier equations from the cache. More...
 
template<class Type >
Foam::CarrierEqn< Type > & carrierEqn (const CloudDerivedField< Type > &psic)
 
template<class Type >
Foam::CarrierEqn< Type > & carrierEqn (const CarrierField< Type > &psic)
 
template<class Type >
Foam::tmp< Foam::LagrangianEqn< Type > > psicEqn (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const LagrangianSubSubField< Type > &psi, const CloudDerivedField< Type > &psic) const
 
template<class Type >
const Foam::CarrierEqn< Type > & carrierEqn (const word &key) const
 
template<class Type >
const Foam::HashTable< const Foam::CarrierEqn< Type > * > carrierEqns (const word &key) const
 
template<class Type >
const Foam::CarrierEqn< Type > & carrierEqn (const VolField< Type > &psi) const
 
template<class Type >
const Foam::HashTable< const Foam::CarrierEqn< Type > * > carrierEqns (const VolField< Type > &psi) const
 

Public Attributes

const dimensionedScalar rhoByRhoc
 Cloud/carrier density ratio. More...
 
- Public Attributes inherited from coupled
const CloudDerivedField< scalar > & nuc
 Carrier kinematic viscosity. More...
 

Protected Attributes

const CloudDerivedField< scalar > & onec
 A uniform field of values equal to one. Used in volume. More...
 
const CloudDerivedField< scalar > & onecPhase
 A uniform field of values equal to one. Used in volume. More...
 

Additional Inherited Members

- Protected Member Functions inherited from coupled
void updateCarrier ()
 Update the cached carrier fields. More...
 
template<class Type >
CarrierEqn< Type > & carrierEqn (const CloudDerivedField< Type > &)
 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...
 
void clearCarrierEqns ()
 Clear the carrier equations. More...
 
template<class Type >
bool initPsicDdt (const LagrangianSubScalarSubField &vOrM, const CloudDerivedField< Type > &psic) const
 Do we need to re-calculate particles that are modified? More...
 
tmp< LagrangianEqn< scalar > > psicEqn (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const CloudDerivedField< scalar > &oneOrRhoc) const
 Return the basic models-only equation for a carrier field. More...
 
template<class Type >
tmp< LagrangianEqn< Type > > psicEqn (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const LagrangianSubSubField< Type > &psi, const CloudDerivedField< Type > &psic) const
 Return the basic models-only equation for a carrier field. More...
 

Detailed Description

Base class for clouds which are coupled to a constant density fluid.

Source files

Definition at line 51 of file coupledToConstantDensityFluid.H.

Constructor & Destructor Documentation

◆ coupledToConstantDensityFluid()

coupledToConstantDensityFluid ( const cloud c,
const carried carriedCloud 
)

Construct from a reference to the cloud.

Definition at line 77 of file coupledToConstantDensityFluid.C.

◆ ~coupledToConstantDensityFluid()

Destructor.

Definition at line 137 of file coupledToConstantDensityFluid.C.

Member Function Documentation

◆ TypeName()

TypeName ( "coupledToConstantDensityFluid"  )

Run-time type information.

◆ rho()

const Foam::dimensionedScalar & rho ( ) const

Cloud density.

Definition at line 144 of file coupledToConstantDensityFluid.C.

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

Here is the call graph for this function:

◆ rhoc()

const Foam::dimensionedScalar & rhoc ( ) const

Carrier density.

Definition at line 160 of file coupledToConstantDensityFluid.C.

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

Here is the call graph for this function:

◆ rhocPhase()

const Foam::dimensionedScalar & rhocPhase ( ) const

Corresponding Eulerian phase density.

Definition at line 176 of file coupledToConstantDensityFluid.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ onec

const CloudDerivedField<scalar>& onec
protected

A uniform field of values equal to one. Used in volume.

transfers to represent the Eulerian volume per unit volume.

Definition at line 93 of file coupledToConstantDensityFluid.H.

◆ onecPhase

const CloudDerivedField<scalar>& onecPhase
protected

A uniform field of values equal to one. Used in volume.

transfers to represent the Eulerian volume per unit volume.

Definition at line 97 of file coupledToConstantDensityFluid.H.

◆ rhoByRhoc

const dimensionedScalar rhoByRhoc

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