File size: 12,429 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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 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/>.
Description
Class for handling debugging switches.
\*---------------------------------------------------------------------------*/
#include "debug.H"
#include "dictionary.H"
#include "IFstream.H"
#include "etcFiles.H"
#include "Ostream.H"
#include "demandDrivenData.H"
#include "IOobject.H"
#include "HashSet.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace debug
{
dictionary* configDictPtr_(nullptr);
dictionary* debugSwitchesPtr_(nullptr);
dictionary* infoSwitchesPtr_(nullptr);
dictionary* optimisationSwitchesPtr_(nullptr);
dictionary* debugDefaultSwitchesPtr_(nullptr);
dictionary* infoDefaultSwitchesPtr_(nullptr);
dictionary* optimisationDefaultSwitchesPtr_(nullptr);
dictionary& debugDefaultSwitches()
{
if (!debugDefaultSwitchesPtr_)
{
debugDefaultSwitchesPtr_ = new dictionary();
}
return *debugDefaultSwitchesPtr_;
}
dictionary& infoDefaultSwitches()
{
if (!infoDefaultSwitchesPtr_)
{
infoDefaultSwitchesPtr_ = new dictionary();
}
return *infoDefaultSwitchesPtr_;
}
dictionary& optimisationDefaultSwitches()
{
if (!optimisationDefaultSwitchesPtr_)
{
optimisationDefaultSwitchesPtr_ = new dictionary();
}
return *optimisationDefaultSwitchesPtr_;
}
// To ensure configDictPtr_ is deleted at the end of the run
class deleteControlDictPtr
{
public:
deleteControlDictPtr()
{}
~deleteControlDictPtr()
{
deleteDemandDrivenData(debugDefaultSwitchesPtr_);
deleteDemandDrivenData(infoDefaultSwitchesPtr_);
deleteDemandDrivenData(optimisationDefaultSwitchesPtr_);
debugSwitchesPtr_ = nullptr;
infoSwitchesPtr_ = nullptr;
optimisationSwitchesPtr_ = nullptr;
deleteDemandDrivenData(configDictPtr_);
}
};
deleteControlDictPtr deleteControlDictPtr_;
//! \endcond
} // End namespace debug
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
Foam::dictionary& Foam::debug::configDict()
{
if (!configDictPtr_)
{
string configDictString(getEnv("FOAM_CONFIGDICT"));
if (!configDictString.empty())
{
// Read from environment
IStringStream is(configDictString);
configDictPtr_ = new dictionary(is);
}
else
{
fileNameList configDictFiles = findEtcFiles("configDict", true);
configDictPtr_ = new dictionary();
forAllReverse(configDictFiles, cdfi)
{
IFstream ifs(configDictFiles[cdfi]);
if (!ifs.good())
{
SafeFatalIOErrorInFunction
(
ifs,
"Cannot open configDict"
);
}
configDictPtr_->merge(dictionary(ifs));
}
// Check for legacy etc controlDict files
// for backwards compatibility
fileNameList controlDictFiles = findEtcFiles("controlDict", false);
if (controlDictFiles.size())
{
cout<< "--> FOAM Warning: legacy controlDict"
" configuration files found:" << std::endl;
forAll(controlDictFiles, i)
{
cout<< " " << controlDictFiles[i] << std::endl;
}
cout<< " Please rename these files controlDict -> configDict"
<< std::endl;
}
forAllReverse(controlDictFiles, cdfi)
{
IFstream ifs(controlDictFiles[cdfi]);
if (!ifs.good())
{
SafeFatalIOErrorInFunction
(
ifs,
"Cannot open controlDict"
);
}
configDictPtr_->merge(dictionary(ifs));
}
}
IFstream ifs("system/configDict");
if (ifs.good())
{
entry::disableFunctionEntries = true;
configDictPtr_->merge(dictionary(ifs));
}
}
return *configDictPtr_;
}
Foam::dictionary& Foam::debug::switchSet
(
const char* subDictName,
dictionary*& subDictPtr
)
{
if (!subDictPtr)
{
entry* ePtr = configDict().lookupEntryPtr
(
subDictName, false, false
);
if (!ePtr || !ePtr->isDict())
{
cerr<< "debug::switchSet(const char*, dictionary*&):\n"
<< " Cannot find " << subDictName << " in dictionary "
<< configDict().name().c_str()
<< std::endl << std::endl;
::exit(1);
}
subDictPtr = &ePtr->dict();
}
return *subDictPtr;
}
Foam::dictionary& Foam::debug::debugSwitches()
{
return switchSet("DebugSwitches", debugSwitchesPtr_);
}
Foam::dictionary& Foam::debug::infoSwitches()
{
return switchSet("InfoSwitches", infoSwitchesPtr_);
}
Foam::dictionary& Foam::debug::optimisationSwitches()
{
return switchSet("OptimisationSwitches", optimisationSwitchesPtr_);
}
int Foam::debug::debugSwitch(const char* name, const int defaultValue)
{
if
(
debugDefaultSwitches().found(name)
&& debugDefaultSwitches().lookup<int>(name) != defaultValue
)
{
FatalErrorInFunction
<< "Multiple defaults set for debug switch " << name
<< exit(FatalError);
}
debugDefaultSwitches().set(name, defaultValue);
return debugSwitches().lookupOrAddDefault(name, defaultValue);
}
int Foam::debug::infoSwitch(const char* name, const int defaultValue)
{
if
(
infoDefaultSwitches().found(name)
&& infoDefaultSwitches().lookup<int>(name) != defaultValue
)
{
FatalErrorInFunction
<< "Multiple defaults set for info switch " << name
<< exit(FatalError);
}
infoDefaultSwitches().set(name, defaultValue);
return infoSwitches().lookupOrAddDefault(name, defaultValue);
}
int Foam::debug::optimisationSwitch(const char* name, const int defaultValue)
{
if
(
optimisationDefaultSwitches().found(name)
&& optimisationDefaultSwitches().lookup<int>(name) != defaultValue
)
{
FatalErrorInFunction
<< "Multiple defaults set for optimisation switch " << name
<< exit(FatalError);
}
optimisationDefaultSwitches().set(name, defaultValue);
return optimisationSwitches().lookupOrAddDefault(name, defaultValue);
}
float Foam::debug::floatOptimisationSwitch
(
const char* name,
const float defaultValue
)
{
if
(
optimisationDefaultSwitches().found(name)
&& optimisationDefaultSwitches().lookup<float>(name) != defaultValue
)
{
FatalErrorInFunction
<< exit(FatalError);
}
optimisationDefaultSwitches().set(name, defaultValue);
return optimisationSwitches().lookupOrAddDefault(name, defaultValue);
}
const Foam::word Foam::debug::wordOptimisationSwitch
(
const char* name,
const word& defaultValue
)
{
if
(
optimisationDefaultSwitches().found(name)
&& optimisationDefaultSwitches().lookup<word>(name) != defaultValue
)
{
FatalErrorInFunction
<< exit(FatalError);
}
optimisationDefaultSwitches().set(name, defaultValue);
return optimisationSwitches().lookupOrAddDefault(name, defaultValue);
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
void listSwitches
(
const wordList& debugSwitches,
const wordList& infoSwitches,
const wordList& optSwitches,
const bool unset
)
{
if (unset)
{
fileNameList configDictFiles = findEtcFiles("configDict", true);
dictionary configDict;
forAllReverse(configDictFiles, cdfi)
{
configDict.merge(dictionary(IFstream(configDictFiles[cdfi])()));
}
wordHashSet configDictDebug
(
configDict.subDict("DebugSwitches").sortedToc()
);
wordHashSet configDictInfo
(
configDict.subDict("InfoSwitches").sortedToc()
);
wordHashSet configDictOpt
(
configDict.subDict("OptimisationSwitches").sortedToc()
);
IOobject::writeDivider(Info);
wordHashSet hashset;
hashset = debugSwitches;
hashset -= configDictDebug;
Info<< "Unset DebugSwitches" << hashset.sortedToc() << endl;
hashset = infoSwitches;
hashset -= configDictInfo;
Info<< "Unset InfoSwitches" << hashset.sortedToc() << endl;
hashset = optSwitches;
hashset -= configDictOpt;
Info<< "Unset OptimisationSwitches" << hashset.sortedToc() << endl;
}
else
{
IOobject::writeDivider(Info);
Info<< "DebugSwitches" << debugSwitches << endl;
Info<< "InfoSwitches" << infoSwitches << endl;
Info<< "OptimisationSwitches" << optSwitches << endl;
}
}
void listSwitches
(
const word& name,
const dictionary& switches,
const dictionary& defaultSwitches
)
{
wordHashSet defaultSet;
wordHashSet nonDefaultSet;
wordHashSet noDefaultSet;
forAllConstIter(dictionary, switches, iter)
{
const word& name = iter().keyword();
const bool hasDefault = defaultSwitches.found(name);
const bool isDefault =
hasDefault
&& defaultSwitches.lookupEntry(name, false, false) == iter();
if (hasDefault)
{
if (isDefault)
{
defaultSet.insert(name);
}
else
{
nonDefaultSet.insert(name);
}
}
else
{
noDefaultSet.insert(name);
}
}
auto print = [&](const char* heading, const wordList& names)
{
Info<< indent << "// " << heading << endl;
forAll(names, i)
{
Info<< switches.lookupEntry(names[i], false, false);
}
};
Info<< name << endl
<< token::BEGIN_BLOCK << endl << incrIndent;
print
(
"Switches with default values",
defaultSet.sortedToc()
);
Info<< nl;
print
(
"Switches with non-default values",
nonDefaultSet.sortedToc()
);
Info<< nl;
print
(
"Switches without defaults",
noDefaultSet.sortedToc()
);
Info<< decrIndent << token::END_BLOCK << endl;
}
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void Foam::debug::listSwitches()
{
listSwitches
(
"DebugSwitches",
debug::debugSwitches(),
debug::debugDefaultSwitches()
);
Info<< endl;
listSwitches
(
"InfoSwitches",
debug::infoSwitches(),
debug::infoDefaultSwitches()
);
Info<< endl;
listSwitches
(
"OptimisationSwitches",
debug::optimisationSwitches(),
debug::optimisationDefaultSwitches()
);
}
// ************************************************************************* //
|