Public Member Functions | List of all members
LocalInteraction< CloudType > Class Template Reference

Patch interaction specified on a patch-by-patch basis. More...

Inheritance diagram for LocalInteraction< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for LocalInteraction< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("localInteraction")
 Runtime type information. More...
 
 LocalInteraction (const dictionary &dict, CloudType &owner)
 Construct from dictionary. More...
 
 LocalInteraction (const LocalInteraction< CloudType > &pim)
 Construct copy from owner cloud and patch interaction model. More...
 
virtual autoPtr< PatchInteractionModel< CloudType > > clone () const
 Construct and return a clone using supplied owner cloud. More...
 
virtual ~LocalInteraction ()
 Destructor. More...
 
volScalarFieldmassEscape ()
 Return access to the massEscape field. More...
 
volScalarFieldmassStick ()
 Return access to the massStick field. More...
 
virtual bool correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)
 Apply velocity correction. More...
 
virtual void info (Ostream &os)
 Write patch interaction info to stream. More...
 
- Public Member Functions inherited from PatchInteractionModel< CloudType >
 TypeName ("patchInteractionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, PatchInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 PatchInteractionModel (CloudType &owner)
 Construct null from owner. More...
 
 PatchInteractionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
 PatchInteractionModel (const PatchInteractionModel< CloudType > &pim)
 Construct copy. More...
 
virtual ~PatchInteractionModel ()
 Destructor. More...
 
const wordUName () const
 Return name of velocity field. 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)
 Construct as copy. 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)
 Construct as copy. 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...
 
virtual bool active () const
 Return the model 'active' status - default active = true. More...
 
virtual void cacheFields (const bool store)
 Cache dependent sub-model fields. 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...
 

Additional Inherited Members

- Public Types inherited from PatchInteractionModel< CloudType >
enum  interactionType {
  itNone, itRebound, itStick, itEscape,
  itOther
}
 
- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Static Public Member Functions inherited from PatchInteractionModel< CloudType >
static autoPtr< PatchInteractionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
static word interactionTypeToWord (const interactionType &itEnum)
 Convert interaction result to word. More...
 
static interactionType wordToInteractionType (const word &itWord)
 Convert word to interaction result. More...
 
- Static Public Attributes inherited from PatchInteractionModel< CloudType >
static wordList interactionTypeNames_
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. 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::LocalInteraction< CloudType >

Patch interaction specified on a patch-by-patch basis.

Definition at line 47 of file LocalInteraction.H.

Constructor & Destructor Documentation

◆ LocalInteraction() [1/2]

LocalInteraction ( const dictionary dict,
CloudType owner 
)

Construct from dictionary.

Definition at line 32 of file LocalInteraction.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, Foam::name(), Foam::nl, and patchi.

Here is the call graph for this function:

◆ LocalInteraction() [2/2]

Construct copy from owner cloud and patch interaction model.

Definition at line 86 of file LocalInteraction.C.

◆ ~LocalInteraction()

~LocalInteraction ( )
virtual

Destructor.

Definition at line 105 of file LocalInteraction.C.

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

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "localInteraction"  )

Runtime type information.

◆ clone()

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

◆ massEscape()

Foam::volScalarField & massEscape ( )

Return access to the massEscape field.

Definition at line 112 of file LocalInteraction.C.

References Foam::dimMass, mesh, Foam::name(), fvMesh::time(), and Time::timeName().

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

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

◆ massStick()

Foam::volScalarField & massStick ( )

Return access to the massStick field.

Definition at line 141 of file LocalInteraction.C.

References LocalInteraction< CloudType >::correct(), Foam::dimMass, mesh, Foam::name(), fvMesh::time(), and Time::timeName().

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

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

◆ correct()

bool correct ( typename CloudType::parcelType p,
const polyPatch pp,
bool &  keepParticle 
)
virtual

Apply velocity correction.

Returns true if particle remains in same cell

Implements PatchInteractionModel< CloudType >.

Definition at line 171 of file LocalInteraction.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::index(), nw, patchi, U, polyPatch::whichFace(), and Foam::Zero.

Referenced by LocalInteraction< CloudType >::clone(), and LocalInteraction< CloudType >::massStick().

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

◆ info()

void info ( Ostream os)
virtual

Write patch interaction info to stream.

Reimplemented from PatchInteractionModel< CloudType >.

Definition at line 278 of file LocalInteraction.C.

References forAll, and Foam::nl.

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

Here is the caller graph for this function:

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