coupledToFluid Class Reference

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

Inheritance diagram for coupledToFluid:
Collaboration diagram for coupledToFluid:

Public Member Functions

 TypeName ("coupledToFluid")
 Run-time type information. More...
 
 coupledToFluid (const cloud &)
 Construct from a reference to the cloud. More...
 
virtual ~coupledToFluid ()
 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 CarrierField< scalar > & rhoc
 Carrier density. More...
 
const CarrierField< scalar > & muc
 Carrier dynamic 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 updateRhoc ()
 Update the carrier density. 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 a fluid.

Source files

Definition at line 50 of file coupledToFluid.H.

Constructor & Destructor Documentation

◆ coupledToFluid()

coupledToFluid ( const cloud c)

Construct from a reference to the cloud.

Definition at line 91 of file coupledToFluid.C.

◆ ~coupledToFluid()

~coupledToFluid ( )
virtual

Destructor.

Definition at line 112 of file coupledToFluid.C.

Member Function Documentation

◆ updateRhoc()

void updateRhoc ( )
protected

Update the carrier density.

Definition at line 80 of file coupledToFluid.C.

Referenced by particle::solve().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "coupledToFluid"  )

Run-time type information.

Member Data Documentation

◆ rhoc

const CarrierField<scalar>& rhoc

Carrier density.

Definition at line 97 of file coupledToFluid.H.

Referenced by gravity::addSup().

◆ muc

const CarrierField<scalar>& muc

Carrier dynamic viscosity.

Definition at line 100 of file coupledToFluid.H.


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