Abstract base class for particle forces. More...
Public Types | |
typedef VectorSpace< Vector< vector >, vector, 2 > | returnType |
Convenience typedef for return type. More... | |
Public Member Functions | |
TypeName ("particleForce") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, ParticleForce, dictionary,(CloudType &owner, const fvMesh &mesh, const dictionary &dict),(owner, mesh, dict)) | |
Declare runtime constructor selection table. More... | |
ParticleForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType, const bool readCoeffs) | |
Construct from mesh. More... | |
ParticleForce (const ParticleForce &pf) | |
Construct copy. More... | |
virtual autoPtr< ParticleForce< CloudType > > | clone () const |
Construct and return a clone. More... | |
virtual | ~ParticleForce () |
Destructor. More... | |
const CloudType & | owner () const noexcept |
Return const access to the cloud owner. More... | |
CloudType & | owner () noexcept |
Return reference to the cloud owner. More... | |
const fvMesh & | mesh () const noexcept |
Return the mesh database. More... | |
const dictionary & | coeffs () const noexcept |
Return the force coefficients dictionary. More... | |
virtual void | cacheFields (const bool store) |
Cache fields. More... | |
virtual forceSuSp | calcCoupled (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const |
Calculate the coupled force. More... | |
virtual forceSuSp | calcNonCoupled (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const |
Calculate the non-coupled force. More... | |
virtual scalar | massAdd (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const |
Return the added mass. More... | |
Static Public Member Functions | |
static autoPtr< ParticleForce< CloudType > > | New (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType) |
Selector. More... | |
Abstract base class for particle forces.
Definition at line 54 of file ParticleForce.H.
typedef VectorSpace<Vector<vector>, vector, 2> returnType |
Convenience typedef for return type.
Definition at line 101 of file ParticleForce.H.
ParticleForce | ( | CloudType & | owner, |
const fvMesh & | mesh, | ||
const dictionary & | dict, | ||
const word & | forceType, | ||
const bool | readCoeffs | ||
) |
Construct from mesh.
Definition at line 27 of file ParticleForce.C.
References dict, Foam::exit(), Foam::FatalIOError, and FatalIOErrorInFunction.
ParticleForce | ( | const ParticleForce< CloudType > & | pf | ) |
Construct copy.
Definition at line 49 of file ParticleForce.C.
|
virtual |
Destructor.
Definition at line 60 of file ParticleForce.C.
TypeName | ( | "particleForce" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
ParticleForce< CloudType > | , | ||
dictionary | , | ||
(CloudType &owner, const fvMesh &mesh, const dictionary &dict) | , | ||
(owner, mesh, dict) | |||
) |
Declare runtime constructor selection table.
|
inlinevirtual |
Construct and return a clone.
Reimplemented in NonSphereDragForce< CloudType >, TomiyamaDragForce< CloudType >, ErgunWenYuDragForce< CloudType >, WenYuDragForce< CloudType >, CoulombForce< CloudType >, PlessisMasliyahDragForce< CloudType >, SphereDragForce< CloudType >, DistortedSphereDragForce< CloudType >, BrownianMotionForce< CloudType >, NonInertialFrameForce< CloudType >, LiftForce< CloudType >, TomiyamaLiftForce< CloudType >, ParamagneticForce< CloudType >, InterfaceForce< CloudType >, PressureGradientForce< CloudType >, SaffmanMeiLiftForce< CloudType >, GravityForce< CloudType >, SRFForce< CloudType >, and VirtualMassForce< CloudType >.
Definition at line 126 of file ParticleForce.H.
|
static |
Selector.
Definition at line 29 of file ParticleForceNew.C.
References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh.
|
inlinenoexcept |
Return const access to the cloud owner.
Definition at line 160 of file ParticleForce.H.
|
inlinenoexcept |
Return reference to the cloud owner.
Definition at line 165 of file ParticleForce.H.
|
inlinenoexcept |
Return the mesh database.
Definition at line 170 of file ParticleForce.H.
|
inlinenoexcept |
Return the force coefficients dictionary.
Definition at line 175 of file ParticleForce.H.
|
virtual |
Cache fields.
Reimplemented in CoulombForce< CloudType >, BrownianMotionForce< CloudType >, NonInertialFrameForce< CloudType >, LiftForce< CloudType >, ParamagneticForce< CloudType >, PressureGradientForce< CloudType >, InterfaceForce< CloudType >, SRFForce< CloudType >, and VirtualMassForce< CloudType >.
Definition at line 67 of file ParticleForce.C.
|
virtual |
Calculate the coupled force.
Reimplemented in NonSphereDragForce< CloudType >, TomiyamaDragForce< CloudType >, ErgunWenYuDragForce< CloudType >, WenYuDragForce< CloudType >, PlessisMasliyahDragForce< CloudType >, SphereDragForce< CloudType >, DistortedSphereDragForce< CloudType >, BrownianMotionForce< CloudType >, LiftForce< CloudType >, PressureGradientForce< CloudType >, and VirtualMassForce< CloudType >.
Definition at line 73 of file ParticleForce.C.
References forceSuSp::Sp(), forceSuSp::Su(), and Foam::Zero.
|
virtual |
Calculate the non-coupled force.
Reimplemented in CoulombForce< CloudType >, NonInertialFrameForce< CloudType >, ParamagneticForce< CloudType >, InterfaceForce< CloudType >, GravityForce< CloudType >, and SRFForce< CloudType >.
Definition at line 92 of file ParticleForce.C.
References forceSuSp::Sp(), forceSuSp::Su(), and Foam::Zero.
|
virtual |
Return the added mass.
Reimplemented in PressureGradientForce< CloudType >, and VirtualMassForce< CloudType >.
Definition at line 111 of file ParticleForce.C.