Place holder for 'none' option. More...

Inheritance diagram for NoCollision< CloudType >:

Collaboration diagram for NoCollision< CloudType >:

Public Member Functions
	TypeName ("none")
	Runtime type information. More...

	NoCollision (const dictionary &dict, CloudType &owner)
	Construct from components. More...

	NoCollision (const NoCollision< CloudType > &cm)
	Construct copy. More...

virtual autoPtr< CollisionModel< CloudType > >	clone () const
	Construct and return a clone. More...

virtual	~NoCollision ()
	Destructor. More...

virtual label	nSubCycles () const
	Return the number of times to subcycle the current. More...

virtual bool	active () const
	Flag to indicate whether model activates collision model. More...

virtual void	collide ()

Public Member Functions inherited from CollisionModel< CloudType >
	TypeName ("collisionModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, CollisionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table. More...

	CollisionModel (CloudType &owner)
	Construct null from owner. More...

	CollisionModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components. More...

	CollisionModel (const CollisionModel< CloudType > &cm)
	Construct copy. More...

virtual	~CollisionModel ()
	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)
	Construct as copy. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

CloudType &	owner ()
	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 word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () 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 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 CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Static Public Member Functions inherited from CollisionModel< CloudType >
static autoPtr< CollisionModel< 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 CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	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::NoCollision< CloudType >

Place holder for 'none' option.

Source files

Definition at line 49 of file NoCollision.H.

Constructor & Destructor Documentation

◆ NoCollision() [1/2]

NoCollision	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from components.

Definition at line 32 of file NoCollision.C.

◆ NoCollision() [2/2]

NoCollision ( const NoCollision< CloudType > & cm )

Construct copy.

Definition at line 43 of file NoCollision.C.

◆ ~NoCollision()

~NoCollision ( )

virtual

Destructor.

Definition at line 54 of file NoCollision.C.

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

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "none" )

Runtime type information.

◆ clone()

virtual autoPtr<CollisionModel<CloudType> > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements CollisionModel< CloudType >.

Definition at line 69 of file NoCollision.H.

References NoCollision< CloudType >::active(), NoCollision< CloudType >::collide(), NoCollision< CloudType >::nSubCycles(), and NoCollision< CloudType >::~NoCollision().

Here is the call graph for this function:

◆ nSubCycles()

Foam::label nSubCycles ( ) const

virtual

Return the number of times to subcycle the current.

timestep to meet the criteria of the collision model. For this model this will always be 1.

Implements CollisionModel< CloudType >.

Definition at line 61 of file NoCollision.C.

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

Here is the caller graph for this function:

◆ active()

bool active ( ) const

virtual

Flag to indicate whether model activates collision model.

Reimplemented from subModelBase.

Definition at line 68 of file NoCollision.C.

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

Here is the caller graph for this function:

◆ collide()

void collide ( )

virtual

Implements CollisionModel< CloudType >.

Definition at line 75 of file NoCollision.C.

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

Here is the caller graph for this function:

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

src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/NoCollision/NoCollision.H
src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/NoCollision/NoCollision.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::NoCollision< CloudType >

Constructor & Destructor Documentation

◆ NoCollision() [1/2]

◆ NoCollision() [2/2]

◆ ~NoCollision()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ nSubCycles()

◆ active()

◆ collide()

template<class CloudType>
class Foam::NoCollision< CloudType >