ParamagneticForce.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2017 OpenFOAM Foundation
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::ParamagneticForce
 
Group
    grpLagrangianIntermediateForceSubModels
 
Description
    Calculates particle paramagnetic (magnetic field) force
 
SourceFiles
    ParamagneticForceI.H
    ParamagneticForce.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_ParamagneticForce_H
#define Foam_ParamagneticForce_H
 
#include "ParticleForce.H"
#include "interpolation.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class ParamagneticForce Declaration
\*---------------------------------------------------------------------------*/
 
template<class CloudType>
class ParamagneticForce
:
    public ParticleForce<CloudType>
{
    // Private Data
 
        //- Name of paramagnetic field strength field - default = "HdotGradH"
        const word HdotGradHName_;
 
        //- HdotGradH interpolator
        const interpolation<vector>* HdotGradHInterpPtr_;
 
        //- Magnetic susceptibility of particle
        const scalar magneticSusceptibility_;
 
 
public:
 
    //- Runtime type information
    TypeName("paramagnetic");
 
 
    // Constructors
 
        //- Construct from mesh
        ParamagneticForce
        (
            CloudType& owner,
            const fvMesh& mesh,
            const dictionary& dict
        );
 
        //- Construct copy
        ParamagneticForce(const ParamagneticForce& gf);
 
        //- Construct and return a clone
        virtual autoPtr<ParticleForce<CloudType>> clone() const
        {
            return autoPtr<ParticleForce<CloudType>>
            (
                new ParamagneticForce<CloudType>(*this)
            );
        }
 
 
    //- Destructor
    virtual ~ParamagneticForce();
 
 
    // Member Functions
 
    // Access
 
        //- Return the name of paramagnetic field strength field
        const word& HdotGradHName() const noexcept { return HdotGradHName_; }
 
        //- Return the magnetic susceptibility of particle
        scalar magneticSusceptibility() const noexcept
        {
            return magneticSusceptibility_;
        }
 
 
        // Evaluation
 
            //- Cache fields
            virtual void cacheFields(const bool store);
 
            //- Calculate the non-coupled force
            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;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "ParamagneticForce.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //