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 -------------------------------------------------------------------------------
8  Copyright (C) 2007-2019 PCOpt/NTUA
9  Copyright (C) 2013-2019 FOSS GP
10  Copyright (C) 2019 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
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 
34 template<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  }
54  }
55 }
56 
57 
58 template<class Type>
60 (
61  fvMatrix<Type>& matrix
62 ) const
63 {
64  // If source has been allocated, add source * variable
65  if (optTypeSource_)
66  {
67  const GeometricField<Type, fvPatchField, volMesh>& psi = matrix.psi();
68 
69  matrix += fvm::Sp(*optTypeSource_, psi);
70  }
71 }
72 
73 
74 // ************************************************************************* //
type
Types of root.
Definition: Roots.H:52
void solveWithArgs(Type &type, List< void(Type::*)()> &funcs)
Main control loop.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: BitOps.H:56
virtual void solveIter()=0
Execute one iteration of the solution algorithm.
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:414
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: POSIX.C:799
bool active_
Solve equations?
Definition: solver.H:76
virtual bool loop()=0
Looper (advances iters, time step)
zeroField Sp(const Foam::zero, const GeometricField< Type, fvPatchField, volMesh > &)
A no-op source.
virtual void preLoop()
Functions to be called before loop.
Definition: solver.C:130
const volScalarField & psi
void addOptimisationTypeSource(fvMatrix< Type > &matrix) const
Add source from optimisationType to underlaying equation.
virtual void postLoop()
Functions to be called after loop.
Definition: solver.C:136
Calculate the finiteVolume matrix for implicit and explicit sources.