Explicit< CloudType > Class Template Reference

Explicit model for applying an inter-particle stress to the particles. More...

Inheritance diagram for Explicit< CloudType >:
Collaboration diagram for Explicit< CloudType >:

Public Member Functions

 TypeName ("explicit")
 Runtime type information. More...
 
 Explicit (const dictionary &dict, CloudType &owner)
 Construct from components. More...
 
 Explicit (const Explicit< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< PackingModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~Explicit ()
 Destructor. More...
 
virtual void cacheFields (const bool store)
 Calculate the inter particles stresses. More...
 
virtual vector velocityCorrection (typename CloudType::parcelType &p, const scalar deltaT) const
 Calculate the velocity correction. More...
 
- Public Member Functions inherited from PackingModel< CloudType >
 TypeName ("packingModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, PackingModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 PackingModel (CloudType &owner)
 Construct null from owner. More...
 
 PackingModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
 PackingModel (const PackingModel< CloudType > &cm)
 Construct copy. More...
 
virtual ~PackingModel ()
 Destructor. More...
 
- Public Member Functions inherited from CloudSubModelBase< CloudType >
 CloudSubModelBase (CloudType &owner)
 Construct null from owner cloud. More...
 
 CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from owner cloud without name. More...
 
 CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from owner cloud with name. More...
 
 CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
 Copy constructor. More...
 
virtual ~CloudSubModelBase ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
CloudTypeowner ()
 Return non-const access to the owner cloud for manipulation. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 Construct null. More...
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from components without name. More...
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from components with name. More...
 
 subModelBase (const subModelBase &smb)
 Copy constructor. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () const
 Return const access to the properties dictionary. More...
 
virtual bool defaultCoeffs (const bool printMsg) const
 Returns true if defaultCoeffs is true and outputs on printMsg. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 Add generic property to the base model. More...
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 Add generic property to the sub-model. More...
 
void operator= (const subModelBase &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Static Public Member Functions inherited from PackingModel< CloudType >
static autoPtr< PackingModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 
- Protected Attributes inherited from PackingModel< CloudType >
autoPtr< ParticleStressModelparticleStressModel_
 Protected data. More...
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

Detailed Description

template<class CloudType>
class Foam::PackingModels::Explicit< CloudType >

Explicit model for applying an inter-particle stress to the particles.

The inter-particle stress is calculated using current particle locations. This force is then applied only to the particles that are moving towards regions of close pack. The resulting velocity change is limited using an abstracted correction velocity limiter.

Reference:

    "An Incompressible Three-Dimensional Multiphase Particle-in-Cell Model
    for Dense Particle Flows"
    D Snider
    Journal of Computational Physics
    Volume 170, Issue 2, Pages 523-549, July 2001
Source files

Definition at line 65 of file Explicit.H.

Constructor & Destructor Documentation

◆ Explicit() [1/2]

Explicit ( const dictionary dict,
CloudType owner 
)

Construct from components.

Definition at line 32 of file Explicit.C.

◆ Explicit() [2/2]

Explicit ( const Explicit< CloudType > &  cm)

Construct copy.

Definition at line 51 of file Explicit.C.

◆ ~Explicit()

~Explicit ( )
virtual

Destructor.

Definition at line 67 of file Explicit.C.

Referenced by Explicit< CloudType >::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "explicit"  )

Runtime type information.

◆ clone()

virtual autoPtr<PackingModel<CloudType> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements PackingModel< CloudType >.

Definition at line 98 of file Explicit.H.

References Explicit< CloudType >::cacheFields(), p, Explicit< CloudType >::velocityCorrection(), and Explicit< CloudType >::~Explicit().

Here is the call graph for this function:

◆ cacheFields()

void cacheFields ( const bool  store)
virtual

Calculate the inter particles stresses.

Reimplemented from subModelBase.

Definition at line 74 of file Explicit.C.

References PtrList< Field< Type > >::clear(), cloudName(), dict, objectRegistry::lookupObject(), mesh, timeName, and Explicit< CloudType >::velocityCorrection().

Referenced by Explicit< CloudType >::clone().

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

◆ velocityCorrection()

Foam::vector velocityCorrection ( typename CloudType::parcelType p,
const scalar  deltaT 
) const
virtual

Calculate the velocity correction.

Implements PackingModel< CloudType >.

Definition at line 141 of file Explicit.C.

References alpha(), and Foam::Zero.

Referenced by Explicit< CloudType >::cacheFields(), and Explicit< CloudType >::clone().

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

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