Adds MPPIC modelling to kinematic clouds. More...
Public Types | |
typedef CloudType | cloudType |
Type of cloud this cloud was instantiated for. More... | |
typedef CloudType::parcelType | parcelType |
Type of parcel the cloud was instantiated for. More... | |
typedef MPPICCloud< CloudType > | MPPICCloudType |
Convenience typedef for this cloud type. More... | |
Public Types inherited from DSMCCloud< ParcelType > | |
typedef ParcelType | parcelType |
Type of parcel the cloud was instantiated for. More... | |
Public Types inherited from Cloud< ParticleType > | |
typedef ParticleType | particleType |
typedef ParticleType | parcelType |
Parcels are just particles. More... | |
Public Member Functions | |
MPPICCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g, bool readFields=true) | |
Construct given carrier gas fields. More... | |
MPPICCloud (MPPICCloud< CloudType > &c, const word &name) | |
Copy constructor with new name. More... | |
MPPICCloud (const fvMesh &mesh, const word &name, const MPPICCloud< CloudType > &c) | |
Copy constructor with new name - creates bare cloud. More... | |
virtual autoPtr< Cloud< parcelType > > | clone (const word &name) |
Construct and return clone based on (this) with new name. More... | |
virtual autoPtr< Cloud< parcelType > > | cloneBare (const word &name) const |
Construct and return bare clone based on (this) with new name. More... | |
virtual | ~MPPICCloud () |
Destructor. More... | |
const MPPICCloud & | cloudCopy () const |
Return a reference to the cloud copy. More... | |
const PackingModel< MPPICCloud< CloudType > > & | packingModel () const |
Return const access to the packing model. More... | |
PackingModel< MPPICCloud< CloudType > > & | packingModel () |
Return a reference to the packing model. More... | |
const DampingModel< MPPICCloud< CloudType > > & | dampingModel () const |
Return const access to the damping model. More... | |
DampingModel< MPPICCloud< CloudType > > & | dampingModel () |
Return a reference to the damping model. More... | |
const IsotropyModel< MPPICCloud< CloudType > > & | isotropyModel () const |
Return const access to the isotropy model. More... | |
IsotropyModel< MPPICCloud< CloudType > > & | isotropyModel () |
Return a reference to the isotropy model. More... | |
void | storeState () |
Store the current cloud state. More... | |
void | restoreState () |
Reset the current cloud to the previously stored state. More... | |
void | evolve () |
Evolve the cloud. More... | |
template<class TrackCloudType > | |
void | motion (TrackCloudType &cloud, typename parcelType::trackingData &td) |
Particle motion. More... | |
void | info () |
I-O. More... | |
Public Member Functions inherited from DSMCCloud< ParcelType > | |
DSMCCloud (const word &cloudName, const fvMesh &mesh, bool readFields=true) | |
Construct given name and mesh, will read Parcels and fields from. More... | |
DSMCCloud (const word &cloudName, const fvMesh &mesh, const IOdictionary &dsmcInitialiseDict) | |
Construct given name, mesh and initialisation dictionary. More... | |
virtual | ~DSMCCloud () |
Destructor. More... | |
const word & | cloudName () const |
Return the cloud type. More... | |
const fvMesh & | mesh () const |
Return reference to the mesh. More... | |
const IOdictionary & | particleProperties () const |
Return particle properties dictionary. More... | |
const List< word > & | typeIdList () const |
Return the idList. More... | |
scalar | nParticle () const |
Return the number of real particles represented by one. More... | |
const List< DynamicList< ParcelType * > > & | cellOccupancy () const |
Return the cell occupancy addressing. More... | |
volScalarField & | sigmaTcRMax () |
Return the sigmaTcRMax field. non-const access to allow. More... | |
scalarField & | collisionSelectionRemainder () |
Return the collision selection remainder field. non-const. More... | |
const List< typename ParcelType::constantProperties > & | constProps () const |
Return all of the constant properties. More... | |
const ParcelType::constantProperties & | constProps (label typeId) const |
Return the constant properties of the given typeId. More... | |
Random & | rndGen () |
Return reference to the random object. More... | |
volScalarField::Boundary & | qBF () |
Return non-const heat flux boundary field reference. More... | |
volVectorField::Boundary & | fDBF () |
Return non-const force density at boundary field reference. More... | |
volScalarField::Boundary & | rhoNBF () |
Return non-const number density boundary field reference. More... | |
volScalarField::Boundary & | rhoMBF () |
Return non-const mass density boundary field reference. More... | |
volScalarField::Boundary & | linearKEBF () |
Return non-const linear kinetic energy density boundary. More... | |
volScalarField::Boundary & | internalEBF () |
Return non-const internal energy density boundary field. More... | |
volScalarField::Boundary & | iDofBF () |
Return non-const internal degree of freedom density boundary. More... | |
volVectorField::Boundary & | momentumBF () |
Return non-const momentum density boundary field reference. More... | |
const volScalarField & | boundaryT () const |
Return macroscopic temperature. More... | |
const volVectorField & | boundaryU () const |
Return macroscopic velocity. More... | |
const volScalarField & | q () const |
Return heat flux at surface field. More... | |
const volVectorField & | fD () const |
Return force density at surface field. More... | |
const volScalarField & | rhoN () const |
Return the real particle number density field. More... | |
const volScalarField & | rhoM () const |
Return the particle mass density field. More... | |
const volScalarField & | dsmcRhoN () const |
Return the field of number of DSMC particles. More... | |
const volScalarField & | linearKE () const |
Return the total linear kinetic energy (translational and. More... | |
const volScalarField & | internalE () const |
Return the internal energy density field. More... | |
const volScalarField & | iDof () const |
Return the average internal degrees of freedom field. More... | |
const volVectorField & | momentum () const |
Return the momentum density field. More... | |
vector | equipartitionLinearVelocity (scalar temperature, scalar mass) |
Generate a random velocity sampled from the Maxwellian speed. More... | |
scalar | equipartitionInternalEnergy (scalar temperature, direction internalDegreesOfFreedom) |
Generate a random internal energy, sampled from the. More... | |
scalar | maxwellianAverageSpeed (scalar temperature, scalar mass) const |
Average particle speed. More... | |
scalarField | maxwellianAverageSpeed (scalarField temperature, scalar mass) const |
scalar | maxwellianRMSSpeed (scalar temperature, scalar mass) const |
RMS particle speed. More... | |
scalarField | maxwellianRMSSpeed (scalarField temperature, scalar mass) const |
scalar | maxwellianMostProbableSpeed (scalar temperature, scalar mass) const |
Most probable speed. More... | |
scalarField | maxwellianMostProbableSpeed (scalarField temperature, scalar mass) const |
const BinaryCollisionModel< DSMCCloud< ParcelType > > & | binaryCollision () const |
Return reference to binary elastic collision model. More... | |
BinaryCollisionModel< DSMCCloud< ParcelType > > & | binaryCollision () |
Return non-const reference to binary elastic collision model. More... | |
const WallInteractionModel< DSMCCloud< ParcelType > > & | wallInteraction () const |
Return reference to wall interaction model. More... | |
WallInteractionModel< DSMCCloud< ParcelType > > & | wallInteraction () |
Return non-const reference to wall interaction model. More... | |
const InflowBoundaryModel< DSMCCloud< ParcelType > > & | inflowBoundary () const |
Return reference to wall interaction model. More... | |
InflowBoundaryModel< DSMCCloud< ParcelType > > & | inflowBoundary () |
Return non-const reference to wall interaction model. More... | |
scalar | massInSystem () const |
Total mass in system. More... | |
vector | linearMomentumOfSystem () const |
Total linear momentum of the system. More... | |
scalar | linearKineticEnergyOfSystem () const |
Total linear kinetic energy in the system. More... | |
scalar | internalEnergyOfSystem () const |
Total internal energy in the system. More... | |
void | info () const |
Print cloud information. More... | |
void | dumpParticlePositions () const |
Dump particle positions to .obj file. More... | |
void | addNewParcel (const vector &position, const label celli, const vector &U, const scalar Ei, const label typeId) |
Add new parcel. More... | |
void | evolve () |
Evolve the cloud (move, collide) More... | |
void | clear () |
Clear the Cloud. More... | |
virtual void | autoMap (const mapPolyMesh &) |
Remap the particles to the correct cells following mesh change. More... | |
Public Member Functions inherited from Cloud< ParticleType > | |
TypeName ("Cloud") | |
Runtime type information. More... | |
Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles) | |
Construct from mesh and a list of particles. More... | |
Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true) | |
Construct from mesh by reading from file with given cloud instance. More... | |
const polyMesh & | pMesh () const |
Return the polyMesh reference. More... | |
virtual label | nParcels () const |
Return the number of particles in the cloud. More... | |
DynamicList< label > & | labels () const |
Return temporary addressing. More... | |
void | addParticle (ParticleType *pPtr) |
Transfer particle to cloud. More... | |
void | deleteParticle (ParticleType &p) |
Remove particle from cloud and delete. More... | |
void | deleteLostParticles () |
Remove lost particles from cloud and delete. More... | |
void | cloudReset (const Cloud< ParticleType > &c) |
Reset the particles. More... | |
template<class TrackCloudType > | |
void | move (TrackCloudType &cloud, typename ParticleType::trackingData &td, const scalar trackTime) |
Move the particles. More... | |
void | autoMap (const mapPolyMesh &) |
Remap the cells of particles corresponding to the. More... | |
IOobject | fieldIOobject (const word &fieldName, const IOobject::readOption r) const |
Helper to construct IOobject for field and current time. More... | |
template<class DataType > | |
void | checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const |
Check lagrangian data field. More... | |
template<class DataType > | |
void | checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType >, DataType > &data) const |
Check lagrangian data fieldfield. More... | |
virtual void | writeFields () const |
Write the field data for the cloud of particles Dummy at. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
Write using stream options. More... | |
void | writePositions () const |
Write positions to <cloudName>_positions.obj file. More... | |
void | storeGlobalPositions () const |
Call this before a topology change. More... | |
Public Member Functions inherited from DSMCBaseCloud | |
TypeName ("DSMCBaseCloud") | |
Runtime type information. More... | |
DSMCBaseCloud ()=default | |
Null constructor. More... | |
virtual | ~DSMCBaseCloud ()=default |
Destructor. More... | |
Protected Member Functions | |
void | setModels () |
Set cloud sub-models. More... | |
Protected Attributes | |
autoPtr< PackingModel< MPPICCloud< CloudType > > > | packingModel_ |
Packing model. More... | |
autoPtr< DampingModel< MPPICCloud< CloudType > > > | dampingModel_ |
Damping model. More... | |
autoPtr< IsotropyModel< MPPICCloud< CloudType > > > | isotropyModel_ |
Exchange model. More... | |
Protected Attributes inherited from Cloud< ParticleType > | |
cloud::geometryType | geometryType_ |
Geometry type. More... | |
Additional Inherited Members | |
Static Public Attributes inherited from Cloud< ParticleType > | |
static word | cloudPropertiesName |
Name of cloud properties dictionary. More... | |
Adds MPPIC modelling to kinematic clouds.
Definition at line 71 of file MPPICCloud.H.
Type of cloud this cloud was instantiated for.
Definition at line 80 of file MPPICCloud.H.
typedef CloudType::parcelType parcelType |
Type of parcel the cloud was instantiated for.
Definition at line 83 of file MPPICCloud.H.
typedef MPPICCloud<CloudType> MPPICCloudType |
Convenience typedef for this cloud type.
Definition at line 86 of file MPPICCloud.H.
MPPICCloud | ( | const word & | cloudName, |
const volScalarField & | rho, | ||
const volVectorField & | U, | ||
const volScalarField & | mu, | ||
const dimensionedVector & | g, | ||
bool | readFields = true |
||
) |
Construct given carrier gas fields.
Definition at line 71 of file MPPICCloud.C.
MPPICCloud | ( | MPPICCloud< CloudType > & | c, |
const word & | name | ||
) |
Copy constructor with new name.
Definition at line 107 of file MPPICCloud.C.
MPPICCloud | ( | const fvMesh & | mesh, |
const word & | name, | ||
const MPPICCloud< CloudType > & | c | ||
) |
Copy constructor with new name - creates bare cloud.
Definition at line 121 of file MPPICCloud.C.
|
virtual |
Destructor.
Definition at line 137 of file MPPICCloud.C.
|
protected |
Set cloud sub-models.
Definition at line 38 of file MPPICCloud.C.
|
inlinevirtual |
Construct and return clone based on (this) with new name.
Definition at line 161 of file MPPICCloud.H.
|
inlinevirtual |
Construct and return bare clone based on (this) with new name.
Definition at line 170 of file MPPICCloud.H.
|
inline |
Return a reference to the cloud copy.
Definition at line 32 of file MPPICCloudI.H.
|
inline |
Return const access to the packing model.
Definition at line 40 of file MPPICCloudI.H.
|
inline |
Return a reference to the packing model.
Definition at line 48 of file MPPICCloudI.H.
|
inline |
Return const access to the damping model.
Definition at line 56 of file MPPICCloudI.H.
|
inline |
Return a reference to the damping model.
Definition at line 64 of file MPPICCloudI.H.
|
inline |
Return const access to the isotropy model.
Definition at line 72 of file MPPICCloudI.H.
|
inline |
Return a reference to the isotropy model.
Definition at line 80 of file MPPICCloudI.H.
void storeState | ( | ) |
Store the current cloud state.
Definition at line 144 of file MPPICCloud.C.
void restoreState | ( | ) |
Reset the current cloud to the previously stored state.
Definition at line 157 of file MPPICCloud.C.
void evolve | ( | ) |
Evolve the cloud.
Definition at line 165 of file MPPICCloud.C.
void motion | ( | TrackCloudType & | cloud, |
typename parcelType::trackingData & | td | ||
) |
Particle motion.
Definition at line 179 of file MPPICCloud.C.
void info | ( | ) |
|
protected |
Packing model.
Definition at line 113 of file MPPICCloud.H.
|
protected |
Damping model.
Definition at line 117 of file MPPICCloud.H.
|
protected |
Exchange model.
Definition at line 121 of file MPPICCloud.H.