File size: 6,075 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\*---------------------------------------------------------------------------*/
#include "solution.H"
#include "Time.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
defineTypeNameAndDebug(solution, 0);
}
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
void Foam::solution::readDict()
{
if (found("cache"))
{
printDictionary print(subDict("cache"));
cache_ = subDict("cache");
caching_ = cache_.lookupOrDefault("active", true);
}
fieldRelaxDict_ = &dictionary::null;
eqnRelaxDict_ = &dictionary::null;
if (found("relaxationFactors"))
{
const dictionary& relaxDict(subDict("relaxationFactors"));
printDictionary print(relaxDict);
if (relaxDict.found("fields") || relaxDict.found("equations"))
{
if (relaxDict.found("fields"))
{
fieldRelaxDict_ = &relaxDict.subDict("fields");
}
if (relaxDict.found("equations"))
{
eqnRelaxDict_ = &relaxDict.subDict("equations");
}
}
else
{
IOWarningInFunction(*this)
<< "Neither fields nor equations specified" << endl;
}
}
if (found("solvers"))
{
solvers_ = &subDict("solvers");
printDictionary print(*solvers_);
}
else
{
solvers_ = &dictionary::null;
}
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::solution::solution
(
const objectRegistry& obr,
const fileName& dictName
)
:
IOdictionary
(
IOobject
(
dictName,
obr.time().system(),
obr,
IOobject::MUST_READ_IF_MODIFIED,
IOobject::NO_WRITE
)
),
cache_("cache", *this),
caching_(false),
fieldRelaxDict_(nullptr),
eqnRelaxDict_(nullptr),
fieldRelaxDefault_(0),
eqnRelaxDefault_(0),
solvers_(nullptr)
{
readDict();
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::solution::cache(const word& name) const
{
if (caching_)
{
if (debug)
{
Info<< "Cache: find entry for " << name << endl;
}
return cache_.found(name);
}
else
{
return false;
}
}
void Foam::solution::enableCache(const word& name) const
{
caching_ = true;
if (debug)
{
Info<< "Enable cache for " << name << endl;
}
cache_.add(name, true);
}
bool Foam::solution::relaxField(const word& name) const
{
if (debug)
{
Info<< "Field relaxation factor for " << name
<< " is " << (fieldRelaxDict_->found(name) ? "set" : "unset")
<< endl;
}
return fieldRelaxDict_->found(name) || fieldRelaxDict_->found("default");
}
bool Foam::solution::relaxEquation(const word& name) const
{
if (debug)
{
Info<< "Find equation relaxation factor for " << name << endl;
}
return eqnRelaxDict_->found(name) || eqnRelaxDict_->found("default");
}
Foam::scalar Foam::solution::fieldRelaxationFactor(const word& name) const
{
if (debug)
{
Info<< "Lookup variable relaxation factor for " << name << endl;
}
if (fieldRelaxDict_->found(name))
{
return fieldRelaxDict_->lookup<scalar>(name);
}
else if (fieldRelaxDefault_ > small)
{
return fieldRelaxDefault_;
}
else
{
FatalIOErrorInFunction
(
*fieldRelaxDict_
) << "Cannot find variable relaxation factor for '" << name
<< "' or a suitable default value."
<< exit(FatalIOError);
return 0;
}
}
Foam::scalar Foam::solution::equationRelaxationFactor(const word& name) const
{
if (debug)
{
Info<< "Lookup equation relaxation factor for " << name << endl;
}
if (eqnRelaxDict_->found(name))
{
return eqnRelaxDict_->lookup<scalar>(name);
}
else if (eqnRelaxDefault_ > small)
{
return eqnRelaxDefault_;
}
else
{
FatalIOErrorInFunction
(
*eqnRelaxDict_
) << "Cannot find equation relaxation factor for '" << name
<< "' or a suitable default value."
<< exit(FatalIOError);
return 0;
}
}
const Foam::dictionary& Foam::solution::solversDict() const
{
return *solvers_;
}
const Foam::dictionary& Foam::solution::solverDict(const word& name) const
{
if (debug)
{
Info<< "Lookup solver for " << name << endl;
}
return solvers_->subDict(name);
}
bool Foam::solution::read()
{
if (regIOobject::read())
{
readDict();
return true;
}
else
{
return false;
}
}
// ************************************************************************* //
|