singleRegionSolutionControlTemplates.C
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) 2018-2023 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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
27 
28 template<class Type>
30 {
32 
33  forAll(fields, i)
34  {
35  VolField<Type>& field = fields[i];
36 
37  const word& fName = field.name();
38 
39  const size_t prevIterField = fName.find("PrevIter");
40 
41  if (prevIterField == word::npos && mesh_.solution().relaxField(fName))
42  {
43  field.storePrevIter();
44  }
45  }
46 }
47 
48 
49 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
Generic GeometricField class.
void storePrevIter() const
Store the field as the previous iteration value.
const word & name() const
Return name.
Definition: IOobject.H:310
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: UPtrList.H:66
const fvSolution & solution() const
Return the fvSchemes.
Definition: fvMesh.C:1761
UPtrList< GeoField > curFields() const
Return the list of current fields of type GeoField.
void storePrevIterTypeFields() const
Store previous iteration for fields.
fvMesh & mesh_
Reference to the mesh.
bool relaxField(const word &name) const
Return true if the relaxation factor is given for the field.
Definition: solution.C:247
A class for handling words, derived from string.
Definition: word.H:62
Info<< "Calculating turbulent flame speed field St\n"<< endl;volScalarField St(IOobject("St", runTime.name(), mesh, IOobject::NO_READ, IOobject::AUTO_WRITE), flameWrinkling->Xi() *Su);multivariateSurfaceInterpolationScheme< scalar >::fieldTable fields
Definition: createFields.H:230