fvScalarMatrix.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) 2011-2013 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26InClass
27 Foam::fvMatrix
28
29Description
30 A scalar instance of fvMatrix
31
32SourceFiles
33 fvScalarMatrix.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef fvScalarMatrix_H
38#define fvScalarMatrix_H
39
40#include "fvMatrix.H"
41#include "fvMatricesFwd.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
49
50// Set reference level for a component of the solution
51// on a given patch face
52template<>
54(
55 const label patchi,
56 const label facei,
57 const direction,
58 const scalar value
59);
60
61template<>
63
64template<>
66
67template<>
69
70template<>
72
73template<>
75
76template<>
78
79
80// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81
82} // End namespace Foam
83
84// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85
86#endif
87
88// ************************************************************************* //
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
SolverPerformance< Type > solve()
Solve returning the solution statistics.
autoPtr< fvSolver > solver()
Construct and return the solver.
tmp< volScalarField > H1() const
Return H(1)
Definition: fvMatrix.C:1394
void setComponentReference(const label patchi, const label facei, const direction cmpt, const scalar value)
Definition: fvMatrixSolve.C:38
tmp< GeometricField< Type, fvPatchField, volMesh > > H() const
Return the H operation source.
Definition: fvMatrix.C:1332
tmp< Field< Type > > residual() const
Return the matrix residual.
SolverPerformance< Type > solveSegregated(const dictionary &)
Solve segregated returning the solution statistics.
A class for managing temporary objects.
Definition: tmp.H:65
Forward declarations of fvMatrix specializations.
Namespace for OpenFOAM.
uint8_t direction
Definition: direction.H:56