drag Class Referenceabstract
Inheritance diagram for drag:
Collaboration diagram for drag:

Public Member Functions

 TypeName ("drag")
 Runtime type information. More...
 
 drag (const word &name, const LagrangianMesh &mesh, const dictionary &modelDict, const dictionary &stateDict)
 Construct from components. More...
 
virtual wordList addSupFields () const
 Return the name of the velocity field. More...
 
virtual void addSup (const LagrangianSubScalarField &deltaT, const LagrangianSubVectorSubField &U, LagrangianEqn< vector > &eqn) const
 Add a source term to the velocity equation. More...
 
virtual void addSup (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &vOrM, const LagrangianSubVectorSubField &U, LagrangianEqn< vector > &eqn) const
 Add a source term to the momentum equation. More...
 
- Public Member Functions inherited from LagrangianModel
 TypeName ("LagrangianModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, LagrangianModel, dictionary,(const word &name, const LagrangianMesh &mesh, const dictionary &modelDict, const dictionary &stateDict),(name, mesh, modelDict, stateDict))
 Declare run-time constructor selection table. More...
 
 LagrangianModel (const word &name, const LagrangianMesh &mesh)
 Construct from components. More...
 
 LagrangianModel (const LagrangianModel &)=delete
 Disallow default bitwise copy construction. More...
 
autoPtr< LagrangianModelclone () const
 Clone. More...
 
virtual ~LagrangianModel ()
 Destructor. More...
 
const wordname () const
 The source name. More...
 
const objectRegistrydb () const
 The database. More...
 
const LagrangianMeshmesh () const
 The mesh. More...
 
virtual bool addsSupToField (const word &) const
 Return true if the LagrangianModel adds a source term to the. More...
 
template<class Type , template< class > class PrimitiveField>
bool addsSupToField (const LagrangianSubField< Type, PrimitiveField > &field) const
 Return true if the LagrangianModels adds a source term to the. More...
 
virtual void postConstruct ()
 Do post construction steps which require access to other models. More...
 
virtual void correct ()
 Correct the LagrangianModel. More...
 
virtual void preModify (const LagrangianMesh &mesh, DynamicList< elementModification > &elementModifications) const
 Identify elements in the Lagrangian mesh which are to be. More...
 
virtual LagrangianSubMesh modify (LagrangianMesh &mesh, const LagrangianSubMesh &modifiedMesh) const
 Instantaneously modify and/or create and remove elements in the. More...
 
virtual void calculate (const LagrangianSubScalarField &deltaT, const bool final)
 Solve equations and/or update continually changing properties. More...
 
virtual void addSup (const LagrangianSubScalarField &deltaT, LagrangianSubScalarField &S) const
 Add a fractional source term. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Add a source term to an equation. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
virtual bool read (const dictionary &modelDict)
 Read dictionary. More...
 
virtual bool write (const bool write) const
 Write data. More...
 
void operator= (const LagrangianModel &)=delete
 Disallow default bitwise assignment. More...
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::word fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 
template<class AlphaRhoFieldType >
Foam::word fieldName (const AlphaRhoFieldType &alphaRhoField)
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::word fieldsName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 
template<class AlphaRhoFieldType >
Foam::word fieldsName (const AlphaRhoFieldType &alphaRhoField)
 
- Public Member Functions inherited from stateModel
 stateModel ()
 Construct null. More...
 
 stateModel (const stateModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~stateModel ()
 Destructor. More...
 
bool writeState (const bool write) const
 Write state. More...
 
virtual void writeState (Ostream &os) const
 Write state. More...
 
virtual void writeProcessorState (Ostream &os) const
 Write processor state. More...
 
void operator= (const stateModel &)=delete
 Disallow default bitwise assignment. More...
 

Public Attributes

const CloudDerivedField< scalar > & D
 Drag coefficient. More...
 

Additional Inherited Members

- Public Types inherited from LagrangianModel
enum class  modification : label { change = 0 , remove = 1 }
 Enumeration of the types of instantaneous modification. More...
 
typedef LagrangianMesh::elementGroup< modificationelementModification
 Class containing an element-index and a modification-enumeration. More...
 
- Static Public Member Functions inherited from LagrangianModel
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static word fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 Return the name of the field associated with a source term. More...
 
template<class AlphaRhoFieldType >
static word fieldName (const AlphaRhoFieldType &alphaRhoField)
 Return the name of the field associated with a source term (base. More...
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static word fieldsName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 Return the name of the product of the fields associated with a. More...
 
template<class AlphaRhoFieldType >
static word fieldsName (const AlphaRhoFieldType &alphaRhoField)
 Return the name of the product of the fields associated with a. More...
 
static autoPtr< LagrangianModelNew (const word &name, const LagrangianMesh &mesh, const dictionary &modelDict)
 Selector. More...
 
- Static Public Member Functions inherited from stateModel
static dictionary stateDict (const word &name, const objectRegistry &db)
 Construct and return the state dictionary for reading. More...
 
- Protected Member Functions inherited from LagrangianModel
template<class Type >
void addSupType (const LagrangianSubScalarField &deltaT, const LagrangianSubSubField< Type > &field, LagrangianEqn< Type > &eqn) const
 Add a source term to an equation. More...
 
template<class Type >
void addSupType (const LagrangianSubScalarField &deltaT, const LagrangianSubScalarSubField &m, const LagrangianSubSubField< Type > &field, LagrangianEqn< Type > &eqn) const
 Add a source term to a mass-weighted equation. More...
 
- Protected Member Functions inherited from cloudLagrangianModel
template<class Cloud , class ... Clouds>
bool isCloud () const
 Determine whether the cloud is one of the given types. More...
 
template<class Cloud , class ... Clouds>
void assertCloud () const
 Generate an error if the cloud is not one of the given types. More...
 
template<class Cloud = Foam::cloud>
const Cloudcloud () const
 Get a reference to the cloud. More...
 
 TypeName ("cloudLagrangianModel")
 Runtime type information. More...
 
 cloudLagrangianModel (const LagrangianModel &)
 Construct from a Lagrangian model. More...
 
virtual ~cloudLagrangianModel ()
 Destructor. More...
 

Detailed Description

Definition at line 51 of file drag.H.

Constructor & Destructor Documentation

◆ drag()

drag ( const word name,
const LagrangianMesh mesh,
const dictionary modelDict,
const dictionary stateDict 
)

Construct from components.

Definition at line 75 of file drag.C.

Member Function Documentation

◆ TypeName()

TypeName ( "drag"  )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const
virtual

Return the name of the velocity field.

Reimplemented from LagrangianModel.

Definition at line 98 of file drag.C.

References U.

◆ addSup() [1/2]

void addSup ( const LagrangianSubScalarField deltaT,
const LagrangianSubVectorSubField U,
LagrangianEqn< vector > &  eqn 
) const
virtual

Add a source term to the velocity equation.

Definition at line 104 of file drag.C.

References U.

◆ addSup() [2/2]

void addSup ( const LagrangianSubScalarField deltaT,
const LagrangianSubScalarSubField vOrM,
const LagrangianSubVectorSubField U,
LagrangianEqn< vector > &  eqn 
) const
virtual

Add a source term to the momentum equation.

Definition at line 117 of file drag.C.

References U.

Member Data Documentation

◆ D

const CloudDerivedField<scalar>& D

Drag coefficient.

Definition at line 84 of file drag.H.


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