Merge remote-tracking branch 'origin/nr/multiSolverFix' into nextRelease
[foam-extend-3.2.git] / src / dynamicMesh / meshMotion / tetMotionSolver / motionDiffs / deformationEnergy / deformationEnergyDiff.H
blob78168bd200bb6801caa1f001cd7d53de758fe19f
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright held by original author
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     deformationEnergyDiff
28 Description
29     Deformation energy based motion diffusion.
31 SourceFiles
32     deformationEnergyDiff.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef deformationEnergyDiff_H
37 #define deformationEnergyDiff_H
39 #include "motionDiff.H"
40 #include "elementFields.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                      Class deformationEnergyDiff Declaration
49 \*---------------------------------------------------------------------------*/
51 class deformationEnergyDiff
53     public motionDiff
55 private:
57     // Private data
59         //- Value of exponent
60         label exponent_;
62         //- NonOrthogonality filed
63 //         elementScalarField deformationEnergy_;
65         //- Diffusion field
66         elementScalarField motionGamma_;
69    // Private Member Functions
71         //- Disallow default bitwise copy construct
72         deformationEnergyDiff(const deformationEnergyDiff&);
74         //- Disallow default bitwise assignment
75         void operator=(const deformationEnergyDiff&);
77 public:
79     //- Runtime type information
80     TypeName("deformationEnergy");
83     // Constructors
85         //- Construct from components
86         deformationEnergyDiff
87         (
88             const tetMotionSolver& mSolver
89         );
92     // Destructor
94         virtual ~deformationEnergyDiff();
97     // Member Functions
99         //- Return diffusivity field
100         virtual const elementScalarField& motionGamma() const
101         {
102             return motionGamma_;
103         }
105         //- Correct the motion diffusivity
106         virtual void correct();
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 } // End namespace Foam
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 #endif
118 // ************************************************************************* //