coupledToIncompressibleFluid Class Reference

Base class for clouds which are coupled to an incompressible fluid. More...

Inheritance diagram for coupledToIncompressibleFluid:
Collaboration diagram for coupledToIncompressibleFluid:

Public Member Functions

 TypeName ("coupledToIncompressibleFluid")
 Run-time type information. More...
 
 coupledToIncompressibleFluid (const cloud &)
 Construct from a reference to the cloud. More...
 
virtual ~coupledToIncompressibleFluid ()
 Destructor. More...
 
- Public Member Functions inherited from coupled
 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
 

Public Attributes

const dimensionedScalar rhoByRhoc
 Cloud/carrier density ratio. More...
 
const CarrierField< scalar > & nuc
 Carrier kinematic viscosity. More...
 
- Public Attributes inherited from coupled
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 updateNuc ()
 Update the carrier kinematic viscosity. More...
 
- Protected Member Functions inherited from coupled
void clearCarrierEqns ()
 Clear the carrier equations. More...
 
void initialise (const bool predict)
 Initialisation hook. More...
 
void partition ()
 Partition hook. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from coupled
static word carrierName (const word &name)
 Modify a name to disambiguate it as relating to the carrier. More...
 

Detailed Description

Base class for clouds which are coupled to an incompressible fluid.

Source files

Definition at line 51 of file coupledToIncompressibleFluid.H.

Constructor & Destructor Documentation

◆ coupledToIncompressibleFluid()

Construct from a reference to the cloud.

Definition at line 91 of file coupledToIncompressibleFluid.C.

◆ ~coupledToIncompressibleFluid()

Destructor.

Definition at line 107 of file coupledToIncompressibleFluid.C.

Member Function Documentation

◆ updateNuc()

void updateNuc ( )
protected

Update the carrier kinematic viscosity.

Definition at line 80 of file coupledToIncompressibleFluid.C.

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

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "coupledToIncompressibleFluid"  )

Run-time type information.

Member Data Documentation

◆ rhoByRhoc

const dimensionedScalar rhoByRhoc

Cloud/carrier density ratio.

Definition at line 101 of file coupledToIncompressibleFluid.H.

Referenced by gravity::addSup(), and totalPressureVelocityLagrangianVectorFieldSource::value().

◆ nuc

const CarrierField<scalar>& nuc

Carrier kinematic viscosity.

Definition at line 104 of file coupledToIncompressibleFluid.H.


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