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

#include <ParamagneticForce.H>

Inheritance diagram for ParamagneticForce< CloudType >:

Collaboration diagram for ParamagneticForce< CloudType >:

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

Additional Inherited Members
Public Types inherited from ParticleForce< CloudType >
typedef VectorSpace< Vector< vector >, vector, 2 >	returnType
	Convenience typedef for return type.
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.

Detailed Description

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

Calculates particle paramagnetic (magnetic field) force.

Source files

Definition at line 52 of file ParamagneticForce.H.

Constructor & Destructor Documentation

◆ ParamagneticForce() [1/2]

template<class CloudType>

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

Construct from mesh.

Definition at line 29 of file ParamagneticForce.C.

References ParticleForce< CloudType >::coeffs(), dict, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, ParticleForce< CloudType >::mesh(), ParticleForce< CloudType >::owner(), and ParticleForce< CloudType >::ParticleForce().

Referenced by clone(), ParamagneticForce(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParamagneticForce() [2/2]

template<class CloudType>

ParamagneticForce ( const ParamagneticForce< CloudType > & gf )

Construct copy.

Definition at line 50 of file ParamagneticForce.C.

References ParamagneticForce(), and ParticleForce< CloudType >::ParticleForce().

Here is the call graph for this function:

◆ ~ParamagneticForce()

template<class CloudType>

~ParamagneticForce ( )

virtual

Destructor.

Definition at line 65 of file ParamagneticForce.C.

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "paramagnetic" )

Runtime type information.

References dict, ParticleForce< CloudType >::mesh(), ParticleForce< CloudType >::owner(), and ParamagneticForce().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

inlinevirtual

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

Definition at line 102 of file ParamagneticForce.H.

References ParamagneticForce().

Here is the call graph for this function:

◆ HdotGradHName()

template<class CloudType>

const word & HdotGradHName ( ) const

inlinenoexcept

Return the name of paramagnetic field strength field.

Definition at line 124 of file ParamagneticForce.H.

References Foam::noexcept.

◆ magneticSusceptibility()

template<class CloudType>

scalar magneticSusceptibility ( ) const

inlinenoexcept

Return the magnetic susceptibility of particle.

Definition at line 129 of file ParamagneticForce.H.

References Foam::noexcept.

◆ cacheFields()

template<class CloudType>

void cacheFields ( const bool store )

virtual

Cache fields.

Reimplemented from ParticleForce< CloudType >.

Definition at line 72 of file ParamagneticForce.C.

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

Here is the call graph for this function:

◆ calcNonCoupled()

template<class CloudType>

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 93 of file ParamagneticForce.C.

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

Here is the call graph for this function:

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

src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Paramagnetic/ParamagneticForce.H
src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Paramagnetic/ParamagneticForce.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParamagneticForce() [1/2]

◆ ParamagneticForce() [2/2]

◆ ~ParamagneticForce()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ HdotGradHName()

◆ magneticSusceptibility()

◆ cacheFields()

◆ calcNonCoupled()