faScalarMatrix.H
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 Class
27  Foam::faScalarMatrix
28 
29 Description
30  Template specialisation for scalar faMatrix
31 
32 SourceFiles
33  faScalarMatrix.C
34 
35 Author
36  Zeljko Tukovic, FMENA
37  Hrvoje Jasak, Wikki Ltd.
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef Foam_faScalarMatrix_H
42 #define Foam_faScalarMatrix_H
43 
44 #include "faMatrix.H"
45 #include "faMatricesFwd.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
53 
54 // Set reference level for a component of the solution
55 // on a given patch face
56 template<>
58 (
59  const label patchi,
60  const label facei,
61  const direction,
62  const scalar value
63 );
64 
65 template<>
66 SolverPerformance<scalar> faMatrix<scalar>::solve(const dictionary&);
67 
68 // Return the matrix residual
69 template<>
70 tmp<scalarField> faMatrix<scalar>::residual() const;
71 
72 // H operator
73 template<>
74 tmp<areaScalarField> faMatrix<scalar>::H() const;
75 
76 
77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78 
79 } // End namespace Foam
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 #endif
84 
85 // ************************************************************************* //
uint8_t direction
Definition: direction.H:46
void setComponentReference(const label patchi, const label facei, const direction cmpt, const scalar value)
Set reference level for a component of the solution on a given patch face.
Definition: faMatrixSolve.C:32
SolverPerformance< Type > solve()
Solve returning the solution statistics.
tmp< GeometricField< Type, faPatchField, areaMesh > > H() const
Return the H operation source.
Definition: faMatrix.C:634
Forward declarations of standard faMatrix types/specializations.
tmp< Field< Type > > residual() const
Return the matrix residual.
Namespace for OpenFOAM.