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