Public Member Functions | List of all members
ParamagneticForce< CloudType > Class Template Reference

Calculates particle paramagnetic (magnetic field) force. More...

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

Public Member Functions

 TypeName ("paramagnetic")
 Runtime type information. More...
 
 ParamagneticForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict)
 Construct from mesh. More...
 
 ParamagneticForce (const ParamagneticForce &gf)
 Construct copy. More...
 
virtual autoPtr< ParticleForce< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~ParamagneticForce ()
 Destructor. More...
 
const word & HdotGradHName () const
 Return the name of paramagnetic field strength field. More...
 
scalar magneticSusceptibility () const
 Return the magnetic susceptibility of particle. More...
 
virtual void cacheFields (const bool store)
 Cache fields. 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...
 
- Public Member Functions inherited from ParticleForce< CloudType >
 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 ~ParticleForce ()
 Destructor. More...
 
const CloudType & owner () const
 Return const access to the cloud owner. More...
 
CloudType & owner ()
 Return references to the cloud owner. More...
 
const fvMesh & mesh () const
 Return the mesh database. More...
 
const dictionary & coeffs () const
 Return the force coefficients dictionary. 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 scalar massAdd (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
 Return the added mass. More...
 

Additional Inherited Members

- Public Types inherited from ParticleForce< CloudType >
typedef VectorSpace< Vector< vector >, vector, 2 > returnType
 Convenience typedef for return type. More...
 
- Static Public Member Functions inherited from ParticleForce< CloudType >
static autoPtr< ParticleForce< CloudType > > New (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType)
 Selector. More...
 

Detailed Description

template<class CloudType>
class Foam::ParamagneticForce< CloudType >

Calculates particle paramagnetic (magnetic field) force.

Source files

Definition at line 53 of file ParamagneticForce.H.

Constructor & Destructor Documentation

◆ ParamagneticForce() [1/2]

ParamagneticForce ( CloudType &  owner,
const fvMesh &  mesh,
const dictionary &  dict 
)

Construct from mesh.

Definition at line 33 of file ParamagneticForce.C.

◆ ParamagneticForce() [2/2]

ParamagneticForce ( const ParamagneticForce< CloudType > &  gf)

Construct copy.

Definition at line 54 of file ParamagneticForce.C.

◆ ~ParamagneticForce()

~ParamagneticForce
virtual

Destructor.

Definition at line 69 of file ParamagneticForce.C.

Member Function Documentation

◆ TypeName()

TypeName ( "paramagnetic"  )

Runtime type information.

◆ clone()

virtual autoPtr<ParticleForce<CloudType> > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

Definition at line 89 of file ParamagneticForce.H.

◆ HdotGradHName()

const Foam::word & HdotGradHName
inline

Return the name of paramagnetic field strength field.

Definition at line 30 of file ParamagneticForceI.H.

◆ magneticSusceptibility()

Foam::scalar magneticSusceptibility
inline

Return the magnetic susceptibility of particle.

Definition at line 38 of file ParamagneticForceI.H.

◆ cacheFields()

void cacheFields ( const bool  store)
virtual

Cache fields.

Reimplemented from ParticleForce< CloudType >.

Definition at line 76 of file ParamagneticForce.C.

References Foam::deleteDemandDrivenData(), mesh, and interpolation< Type >::New().

Here is the call graph for this function:

◆ calcNonCoupled()

Foam::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
virtual

Calculate the non-coupled force.

Reimplemented from ParticleForce< CloudType >.

Definition at line 97 of file ParamagneticForce.C.

References interpolation< Type >::interpolate(), Foam::constant::electromagnetic::mu0, p, forceSuSp::Su(), dimensioned< Type >::value(), and Foam::Zero.

Here is the call graph for this function:
The documentation for this class was generated from the following files: