fvScalarMatrix.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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 InClass
25  Foam::fvMatrix
26 
27 Description
28  A scalar instance of fvMatrix
29 
30 SourceFiles
31  fvScalarMatrix.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fvScalarMatrix_H
36 #define fvScalarMatrix_H
37 
38 #include "fvMatrix.H"
39 #include "fvMatricesFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
47 
48 // Set reference level for a component of the solution
49 // on a given patch face
50 template<>
52 (
53  const label patchi,
54  const label facei,
55  const direction,
56  const scalar value
57 );
58 
59 template<>
60 autoPtr<fvMatrix<scalar>::fvSolver> fvMatrix<scalar>::solver
61 (
62  const dictionary&
63 );
64 
65 template<>
67 (
68  const dictionary&
69 );
70 
71 template<>
73 (
74  const dictionary&
75 );
76 
77 template<>
78 tmp<scalarField> fvMatrix<scalar>::residual() const;
79 
80 template<>
81 tmp<volScalarField> fvMatrix<scalar>::H() const;
82 
83 template<>
84 tmp<volScalarField> fvMatrix<scalar>::H1() const;
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
uint8_t direction
Definition: direction.H:45
tmp< GeometricField< Type, fvPatchField, volMesh > > H() const
Return the H operation source.
Definition: fvMatrix.C:766
tmp< volScalarField > H1() const
Return H(1)
Definition: fvMatrix.C:828
SolverPerformance< Type > solve()
Solve returning the solution statistics.
Forward declarations of fvMatrix specializations.
label patchi
autoPtr< fvSolver > solver()
Construct and return the solver.
void setComponentReference(const label patchi, const label facei, const direction cmpt, const scalar value)
Set reference level for a component of the solution.
Definition: fvMatrixSolve.C:33
SolverPerformance< Type > solveSegregated(const dictionary &)
Solve segregated returning the solution statistics.
tmp< Field< Type > > residual() const
Return the matrix residual.
Namespace for OpenFOAM.
SolverPerformance< scalar > solverPerformance
SolverPerformance instantiated for a scalar.