Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
PatchInteractionModel< CloudType > Class Template Referenceabstract

Templated patch interaction model class. More...

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

Public Types

enum  interactionType { itRebound, itStick, itEscape, itOther }
 
- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 

Public Member Functions

 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 autoPtr< PatchInteractionModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~PatchInteractionModel ()
 Destructor. More...
 
const wordUName () const
 Return name of velocity field. More...
 
virtual bool correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle, const scalar trackFraction, const tetIndices &tetIs)=0
 Apply velocity correction. More...
 
virtual void info (Ostream &os)
 Write patch interaction info to stream. 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 outputTime () 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 dependant 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...
 

Static Public Member Functions

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

static wordList interactionTypeNames_
 

Additional Inherited Members

- 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::PatchInteractionModel< CloudType >

Templated patch interaction model class.

Source files

Definition at line 82 of file KinematicCloud.H.

Member Enumeration Documentation

Enumerator
itRebound 
itStick 
itEscape 
itOther 

Definition at line 65 of file PatchInteractionModel.H.

Constructor & Destructor Documentation

Construct null from owner.

Definition at line 108 of file PatchInteractionModel.C.

Referenced by PatchInteractionModel< CloudType >::PatchInteractionModel(), and PatchInteractionModel< CloudType >::wordToInteractionType().

Here is the caller graph for this function:

PatchInteractionModel ( const dictionary dict,
CloudType owner,
const word type 
)

Construct from components.

Definition at line 119 of file PatchInteractionModel.C.

References PatchInteractionModel< CloudType >::PatchInteractionModel().

Here is the call graph for this function:

Construct copy.

Definition at line 132 of file PatchInteractionModel.C.

~PatchInteractionModel ( )
virtual

Destructor.

Definition at line 144 of file PatchInteractionModel.C.

Member Function Documentation

TypeName ( "patchInteractionModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
PatchInteractionModel< CloudType ,
dictionary  ,
( const dictionary &dict, CloudType &owner ,
(dict, owner  
)

Declare runtime constructor selection table.

virtual autoPtr<PatchInteractionModel<CloudType> > clone ( ) const
pure virtual
Foam::autoPtr< Foam::PatchInteractionModel< CloudType > > New ( const dictionary dict,
CloudType owner 
)
static

Selector.

Definition at line 33 of file PatchInteractionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

const Foam::word & UName ( ) const

Return name of velocity field.

Definition at line 151 of file PatchInteractionModel.C.

Foam::word interactionTypeToWord ( const interactionType itEnum)
static

Convert interaction result to word.

Definition at line 46 of file PatchInteractionModel.C.

References PatchInteractionModel< CloudType >::wordToInteractionType().

Here is the call graph for this function:

Foam::PatchInteractionModel< CloudType >::interactionType wordToInteractionType ( const word itWord)
static

Convert word to interaction result.

Definition at line 81 of file PatchInteractionModel.C.

References PatchInteractionModel< CloudType >::PatchInteractionModel().

Referenced by PatchInteractionModel< CloudType >::interactionTypeToWord().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool correct ( typename CloudType::parcelType p,
const polyPatch pp,
bool &  keepParticle,
const scalar  trackFraction,
const tetIndices tetIs 
)
pure virtual

Apply velocity correction.

Returns true if particle remains in same cell

Implemented in MultiInteraction< CloudType >, StandardWallInteraction< CloudType >, LocalInteraction< CloudType >, Rebound< CloudType >, and NoInteraction< CloudType >.

void info ( Ostream os)
virtual

Write patch interaction info to stream.

Reimplemented in StandardWallInteraction< CloudType >, and LocalInteraction< CloudType >.

Definition at line 158 of file PatchInteractionModel.C.

Member Data Documentation

Foam::wordList interactionTypeNames_
static

Definition at line 73 of file PatchInteractionModel.H.


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