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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::ParamagneticForce
  26
  27 Description
  28     Calculates particle paramagnetic (magnetic field) force
  29
  30 SourceFiles
  31     ParamagneticForceI.H
  32     ParamagneticForce.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef ParamagneticForce_H
  37 #define ParamagneticForce_H
  38
  39 #include "ParticleForce.H"
  40 #include "interpolation.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 class fvMesh;
  48
  49 /*---------------------------------------------------------------------------*\
  50                        Class ParamagneticForce Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class CloudType>
  54 class ParamagneticForce
  55 :
  56     public ParticleForce<CloudType>
  57 {
  58     // Private data
  59
  60         //- Name of paramagnetic field strength field - default = "HdotGradH"
  61         const word HdotGradHName_;
  62
  63         //- HdotGradH interpolator
  64         const interpolation<vector>* HdotGradHInterpPtr_;
  65
  66         //- Magnetic susceptibility of particle
  67         const scalar magneticSusceptibility_;
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("paramagnetic");
  74
  75
  76     // Constructors
  77
  78         //- Construct from mesh
  79         ParamagneticForce
  80         (
  81             CloudType& owner,
  82             const fvMesh& mesh,
  83             const dictionary& dict
  84         );
  85
  86         //- Construct copy
  87         ParamagneticForce(const ParamagneticForce& gf);
  88
  89         //- Construct and return a clone
  90         virtual autoPtr<ParticleForce<CloudType> > clone() const
  91         {
  92             return autoPtr<ParticleForce<CloudType> >
  93             (
  94                 new ParamagneticForce<CloudType>(*this)
  95             );
  96         }
  97
  98
  99     //- Destructor
 100     virtual ~ParamagneticForce();
 101
 102
 103     // Member Functions
 104
 105         // Access
 106
 107             //- Return the name of paramagnetic field strength field
 108             const word& HdotGradHName() const;
 109
 110             //- Return the magnetic susceptibility of particle
 111             scalar magneticSusceptibility() const;
 112
 113
 114         // Evaluation
 115
 116             //- Cache fields
 117             virtual void cacheFields(const bool store);
 118
 119             //- Calculate the non-coupled force
 120             virtual forceSuSp calcNonCoupled
 121             (
 122                 const typename CloudType::parcelType& p,
 123                 const scalar dt,
 124                 const scalar mass,
 125                 const scalar Re,
 126                 const scalar muc
 127             ) const;
 128 };
 129
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 } // End namespace Foam
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #include "ParamagneticForceI.H"
 138
 139 #ifdef NoRepository
 140     #include "ParamagneticForce.C"
 141 #endif
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #endif
 146
 147 // ************************************************************************* //