Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MPPICCloud< CloudType > Class Template Reference
Lagrangian particle models » Clouds

Adds MPPIC modelling to kinematic clouds. More...

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

Public Types

typedef CloudType cloudType
 
typedef CloudType::parcelType parcelType
 
typedef MPPICCloud< CloudType > MPPICCloudType
 
- Public Types inherited from DSMCCloud< ParcelType >
typedef ParcelType parcelType
 
- Public Types inherited from Cloud
typedef ParticleType particleType
 
typedef ParticleType parcelType
 

Public Member Functions

 MPPICCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g, bool readFields=true)
 
 MPPICCloud (MPPICCloud< CloudType > &c, const word &name)
 
 MPPICCloud (const fvMesh &mesh, const word &name, const MPPICCloud< CloudType > &c)
 
virtual autoPtr< Cloud< parcelType > > clone (const word &name)
 
virtual autoPtr< Cloud< parcelType > > cloneBare (const word &name) const
 
virtual ~MPPICCloud ()
 
const MPPICCloud & cloudCopy () const
 
const PackingModel< MPPICCloud< CloudType > > & packingModel () const
 
PackingModel< MPPICCloud< CloudType > > & packingModel ()
 
const DampingModel< MPPICCloud< CloudType > > & dampingModel () const
 
DampingModel< MPPICCloud< CloudType > > & dampingModel ()
 
const IsotropyModel< MPPICCloud< CloudType > > & isotropyModel () const
 
IsotropyModel< MPPICCloud< CloudType > > & isotropyModel ()
 
void storeState ()
 
void restoreState ()
 
void evolve ()
 
template<class TrackCloudType >
void motion (TrackCloudType &cloud, typename parcelType::trackingData &td)
 
void info ()
 
- Public Member Functions inherited from DSMCCloud< ParcelType >
 DSMCCloud (const word &cloudName, const fvMesh &mesh, bool readFields=true)
 
 DSMCCloud (const word &cloudName, const fvMesh &mesh, const IOdictionary &dsmcInitialiseDict)
 
virtual ~DSMCCloud ()
 
const word & cloudName () const
 
const fvMesh & mesh () const
 
const IOdictionary & particleProperties () const
 
const List< word > & typeIdList () const
 
scalar nParticle () const
 
const List< DynamicList< ParcelType * > > & cellOccupancy () const
 
volScalarField & sigmaTcRMax ()
 
scalarField & collisionSelectionRemainder ()
 
const List< typename ParcelType::constantProperties > & constProps () const
 
const ParcelType::constantProperties & constProps (label typeId) const
 
Random & rndGen ()
 
volScalarField::Boundary & qBF ()
 
volVectorField::Boundary & fDBF ()
 
volScalarField::Boundary & rhoNBF ()
 
volScalarField::Boundary & rhoMBF ()
 
volScalarField::Boundary & linearKEBF ()
 
volScalarField::Boundary & internalEBF ()
 
volScalarField::Boundary & iDofBF ()
 
volVectorField::Boundary & momentumBF ()
 
const volScalarField & boundaryT () const
 
const volVectorField & boundaryU () const
 
const volScalarField & q () const
 
const volVectorField & fD () const
 
const volScalarField & rhoN () const
 
const volScalarField & rhoM () const
 
const volScalarField & dsmcRhoN () const
 
const volScalarField & linearKE () const
 
const volScalarField & internalE () const
 
const volScalarField & iDof () const
 
const volVectorField & momentum () const
 
vector equipartitionLinearVelocity (scalar temperature, scalar mass)
 
scalar equipartitionInternalEnergy (scalar temperature, direction internalDegreesOfFreedom)
 
scalar maxwellianAverageSpeed (scalar temperature, scalar mass) const
 
scalarField maxwellianAverageSpeed (scalarField temperature, scalar mass) const
 
scalar maxwellianRMSSpeed (scalar temperature, scalar mass) const
 
scalarField maxwellianRMSSpeed (scalarField temperature, scalar mass) const
 
scalar maxwellianMostProbableSpeed (scalar temperature, scalar mass) const
 
scalarField maxwellianMostProbableSpeed (scalarField temperature, scalar mass) const
 
const BinaryCollisionModel< DSMCCloud< ParcelType > > & binaryCollision () const
 
BinaryCollisionModel< DSMCCloud< ParcelType > > & binaryCollision ()
 
const WallInteractionModel< DSMCCloud< ParcelType > > & wallInteraction () const
 
WallInteractionModel< DSMCCloud< ParcelType > > & wallInteraction ()
 
const InflowBoundaryModel< DSMCCloud< ParcelType > > & inflowBoundary () const
 
InflowBoundaryModel< DSMCCloud< ParcelType > > & inflowBoundary ()
 
scalar massInSystem () const
 
vector linearMomentumOfSystem () const
 
scalar linearKineticEnergyOfSystem () const
 
scalar internalEnergyOfSystem () const
 
void info () const
 
void dumpParticlePositions () const
 
void addNewParcel (const vector &position, const label celli, const vector &U, const scalar Ei, const label typeId)
 
void evolve ()
 
void clear ()
 
virtual void autoMap (const mapPolyMesh &)
 
- Public Member Functions inherited from Cloud
 TypeName ("Cloud")
 
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles)
 
 Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true)
 
const polyMesh & pMesh () const
 
virtual label nParcels () const
 
DynamicList< label > & labels () const
 
void addParticle (ParticleType *pPtr)
 
void deleteParticle (ParticleType &p)
 
void deleteLostParticles ()
 
void cloudReset (const Cloud< ParticleType > &c)
 
template<class TrackCloudType >
void move (TrackCloudType &cloud, typename ParticleType::trackingData &td, const scalar trackTime)
 
void autoMap (const mapPolyMesh &)
 
IOobject fieldIOobject (const word &fieldName, const IOobject::readOption r) const
 
template<class DataType >
void checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const
 
template<class DataType >
void checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType >, DataType > &data) const
 
template<class Type >
bool readStoreFile (const IOobject &io, const IOobject &ioNew) const
 
void readFromFiles (objectRegistry &obr, const wordRes &selectFields) const
 
virtual void writeFields () const
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
void writePositions () const
 
void storeGlobalPositions () const
 
- Public Member Functions inherited from DSMCBaseCloud
 TypeName ("DSMCBaseCloud")
 
 DSMCBaseCloud ()=default
 
virtual ~DSMCBaseCloud ()=default
 

Protected Member Functions

void setModels ()
 

Protected Attributes

autoPtr< PackingModel< MPPICCloud< CloudType > > > packingModel_
 
autoPtr< DampingModel< MPPICCloud< CloudType > > > dampingModel_
 
autoPtr< IsotropyModel< MPPICCloud< CloudType > > > isotropyModel_
 
- Protected Attributes inherited from Cloud
cloud::geometryType geometryType_
 

Additional Inherited Members

- Static Public Attributes inherited from Cloud
static word cloudPropertiesName
 

Detailed Description

template<class CloudType>
class Foam::MPPICCloud< CloudType >

Adds MPPIC modelling to kinematic clouds.

Source files

Definition at line 67 of file MPPICCloud.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Definition at line 76 of file MPPICCloud.H.

◆ parcelType

typedef CloudType::parcelType parcelType

Definition at line 79 of file MPPICCloud.H.

◆ MPPICCloudType

typedef MPPICCloud<CloudType> MPPICCloudType

Definition at line 82 of file MPPICCloud.H.

Constructor & Destructor Documentation

◆ MPPICCloud() [1/3]

MPPICCloud ( const word &  cloudName,
const volScalarField &  rho,
const volVectorField &  U,
const volScalarField &  mu,
const dimensionedVector &  g,
bool  readFields = true 
)

Definition at line 64 of file MPPICCloud.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::readFields().

Here is the call graph for this function:

◆ MPPICCloud() [2/3]

MPPICCloud ( MPPICCloud< CloudType > &  c,
const word &  name 
)

Definition at line 100 of file MPPICCloud.C.

◆ MPPICCloud() [3/3]

MPPICCloud ( const fvMesh &  mesh,
const word &  name,
const MPPICCloud< CloudType > &  c 
)

Definition at line 114 of file MPPICCloud.C.

◆ ~MPPICCloud()

~MPPICCloud
virtual

Definition at line 130 of file MPPICCloud.C.

Member Function Documentation

◆ setModels()

void setModels
protected

Definition at line 31 of file MPPICCloud.C.

References Foam::New().

Here is the call graph for this function:

◆ clone()

virtual autoPtr<Cloud<parcelType> > clone ( const word &  name)
inlinevirtual

Definition at line 157 of file MPPICCloud.H.

References Foam::name().

Here is the call graph for this function:

◆ cloneBare()

virtual autoPtr<Cloud<parcelType> > cloneBare ( const word &  name) const
inlinevirtual

Definition at line 166 of file MPPICCloud.H.

References DSMCCloud< ParcelType >::mesh().

Here is the call graph for this function:

◆ cloudCopy()

const Foam::MPPICCloud< CloudType > & cloudCopy
inline

Definition at line 25 of file MPPICCloudI.H.

◆ packingModel() [1/2]

Foam::PackingModel< Foam::MPPICCloud< CloudType > > & packingModel
inline

Definition at line 33 of file MPPICCloudI.H.

◆ packingModel() [2/2]

PackingModel<MPPICCloud<CloudType> >& packingModel ( )
inline

◆ dampingModel() [1/2]

Foam::DampingModel< Foam::MPPICCloud< CloudType > > & dampingModel
inline

Definition at line 49 of file MPPICCloudI.H.

◆ dampingModel() [2/2]

DampingModel<MPPICCloud<CloudType> >& dampingModel ( )
inline

◆ isotropyModel() [1/2]

Foam::IsotropyModel< Foam::MPPICCloud< CloudType > > & isotropyModel
inline

Definition at line 65 of file MPPICCloudI.H.

◆ isotropyModel() [2/2]

IsotropyModel<MPPICCloud<CloudType> >& isotropyModel ( )
inline

◆ storeState()

void storeState

Definition at line 137 of file MPPICCloud.C.

References Foam::name().

Here is the call graph for this function:

◆ restoreState()

void restoreState

Definition at line 150 of file MPPICCloud.C.

◆ evolve()

void evolve

Definition at line 158 of file MPPICCloud.C.

References solve().

Here is the call graph for this function:

◆ motion()

void motion ( TrackCloudType &  cloud,
typename parcelType::trackingData &  td 
)

Definition at line 172 of file MPPICCloud.C.

References coupled(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and mesh.

Here is the call graph for this function:

◆ info()

void info

Definition at line 273 of file MPPICCloud.C.

References Foam::constant::atomic::alpha, alphaMax(), cellOccupancy, cells, Foam::endl(), forAll, Foam::gMax(), Foam::gMin(), Foam::Info, mesh, n, and reduce().

Here is the call graph for this function:

Member Data Documentation

◆ packingModel_

autoPtr<PackingModel<MPPICCloud<CloudType> > > packingModel_
protected

Definition at line 109 of file MPPICCloud.H.

◆ dampingModel_

autoPtr<DampingModel<MPPICCloud<CloudType> > > dampingModel_
protected

Definition at line 113 of file MPPICCloud.H.

◆ isotropyModel_

autoPtr<IsotropyModel<MPPICCloud<CloudType> > > isotropyModel_
protected

Definition at line 117 of file MPPICCloud.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17