The open source CFD toolbox
solverTemplates.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-------------------------------------------------------------------------------
9 Copyright (C) 2013-2019 FOSS GP
10 Copyright (C) 2019 OpenCFD Ltd.
11-------------------------------------------------------------------------------
13 This file is part of OpenFOAM.
14
15 OpenFOAM is free software: you can redistribute it and/or modify it
17 the Free Software Foundation, either version 3 of the License, or
18 (at your option) any later version.
19
20 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23 for more details.
24
25 You should have received a copy of the GNU General Public License
26 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27
28\*---------------------------------------------------------------------------*/
29
30#include "fvmSup.H"
31
32// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
33
34template<class Type>
36(
37 Type& type,
38 List<void (Type::*)()>& funcs
39)
40{
41 // Iterate
42 if (active_)
43 {
44 preLoop();
45 while (loop())
46 {
47 solveIter();
48 forAll(funcs, fI)
49 {
50 (type.*funcs[fI])();
51 }
52 }
53 postLoop();
54 }
55}
56
57
58template<class Type>
60(
61 fvMatrix<Type>& matrix
62) const
63{
64 // If source has been allocated, add source * variable
65 if (optTypeSource_)
66 {
68
69 matrix += fvm::Sp(*optTypeSource_, psi);
70 }
71}
72
73
74// ************************************************************************* //
Generic GeometricField class.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: List.H:77
A special matrix type and solver, designed for finite volume solutions of scalar equations....
Definition: fvMatrix.H:121
const GeometricField< Type, fvPatchField, volMesh > & psi(const label i=0) const
Return psi.
Definition: fvMatrix.H:412
void solveWithArgs(Type &type, List< void(Type::*)()> &funcs)
Main control loop.
bool active_
Solve equations?
Definition: solver.H:72
virtual void solveIter()=0
Execute one iteration of the solution algorithm.
virtual void preLoop()
Functions to be called before loop.
Definition: solver.C:137
virtual void postLoop()
Functions to be called after loop.
Definition: solver.C:143
void addOptimisationTypeSource(fvMatrix< Type > &matrix) const
Add source from optimisationType to underlaying equation.
virtual bool loop()=0