famDiv.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016-2017 Wikki Ltd
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "famDiv.H"
29 #include "faMesh.H"
30 #include "faMatrix.H"
31 #include "faConvectionScheme.H"
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace fam
41 {
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 template<class Type>
47 div
48 (
49  const edgeScalarField& flux,
51  const word& name
52 )
53 {
54  const areaVectorField& n = vf.mesh().faceAreaNormals();
55 
57  (
59  (
60  vf.mesh(),
61  flux,
62  vf.mesh().divScheme(name)
63  ).ref().famDiv(flux, vf)
64  );
65  faMatrix<Type>& M = tM.ref();
66 
68  (
70  (
71  vf.mesh(),
72  flux,
73  vf.mesh().divScheme(name)
74  ).ref().facDiv(flux, vf)
75  );
76 
77  //HJ Check if the product is from left or right. HJ, 6/Dec/2016
78  M -= n*(n & v);
79 
80  return tM;
81 }
82 
83 
84 template<class Type>
86 div
87 (
88  const tmp<edgeScalarField>& tflux,
90  const word& name
91 )
92 {
93  tmp<faMatrix<Type>> Div(fam::div(tflux(), vf, name));
94  tflux.clear();
95 
96  return Div;
97 }
98 
99 
100 template<class Type>
102 div
103 (
104  const edgeScalarField& flux,
106 )
107 {
108  return fam::div(flux, vf, "div("+flux.name()+','+vf.name()+')');
109 }
110 
111 template<class Type>
113 div
114 (
115  const tmp<edgeScalarField>& tflux,
117 )
118 {
119  tmp<faMatrix<Type>> Div(fam::div(tflux(), vf));
120  tflux.clear();
121 
122  return Div;
123 }
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace fam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace Foam
133 
134 // ************************************************************************* //
const word & name() const noexcept
Return the object name.
Definition: IOobjectI.H:195
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
Abstract base class for finite area calculus convection schemes.
Calculate the matrix for the divergence of the given field and flux.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
A class for handling words, derived from Foam::string.
Definition: word.H:63
const Mesh & mesh() const noexcept
Return mesh.
rDeltaT ref()
tmp< faMatrix< Type > > div(const edgeScalarField &flux, const GeometricField< Type, faPatchField, areaMesh > &vf, const word &name)
Definition: famDiv.C:41
A special matrix type and solver, designed for finite area solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.
Definition: faMatricesFwd.H:37
label n
void clear() const noexcept
If object pointer points to valid object: delete object and set pointer to nullptr.
Definition: tmpI.H:289
A class for managing temporary objects.
Definition: HashPtrTable.H:50
Calculate the matrix for the second temporal derivative.
#define M(I)
Namespace for OpenFOAM.