zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: mutable libs() access in Time and other classes (#1737)

Browse Source 
- This reflects the pre-existing coding situation where const_cast was
  used throughout to effect the same.

STYLE: fix private/protected access

- CodedField, codedMixedFvPatchField
This commit is contained in:
Mark Olesen
2020-07-14 10:48:50 +02:00
parent 41d3e6f1d4
commit 1e7c6ea2f1
30 changed files with 79 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/OpenFOAM/db/Time/Time.H
View File

@ -130,14 +130,14 @@ public:
private:
// Private data
// Private Data
//- Profiling trigger for time-loop (for run, loop)
mutable std::unique_ptr<profilingTrigger> loopProfiling_;
//- Any loaded dynamic libraries. Make sure to construct before
// reading controlDict.
dlLibraryTable libs_;
//- Any loaded dynamic libraries
// Construct before reading controlDict
mutable dlLibraryTable libs_;
//- The controlDict
unwatchedIOdictionary controlDict_;
@ -145,7 +145,7 @@ private:
protected:
// Protected data
// Protected Data
label startTimeIndex_;
@ -502,14 +502,8 @@ public:
return functionObjects_;
}
//- External access to the loaded libraries
const dlLibraryTable& libs() const
{
return libs_;
}
//- External access to the loaded libraries
dlLibraryTable& libs()
//- Mutable access to the loaded dynamic libraries
dlLibraryTable& libs() const
{
return libs_;
}

2
src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.C
View File

@ -73,7 +73,7 @@ Foam::dlLibraryTable& Foam::functionEntries::codeStream::libs
(
dict.topDict()
);
return const_cast<Time&>(d.time()).libs();
return d.time().libs();
}

18
src/OpenFOAM/db/dynamicLibrary/codedBase/codedBase.H
View File

@ -49,6 +49,7 @@ SourceFiles
#include "dictionary.H"
#include "dynamicCodeContext.H"
#include "fileName.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
@ -100,12 +101,6 @@ class codedBase
const dynamicCodeContext& context
) const;
//- No copy construct
codedBase(const codedBase&) = delete;
//- No copy assignment
void operator=(const codedBase&) = delete;
protected:
@ -141,7 +136,7 @@ protected:
//- or use the codeDict() to generate one
void updateLibrary(const word& name) const;
//- Get the loaded dynamic libraries
//- Mutable access to the loaded dynamic libraries
virtual dlLibraryTable& libs() const = 0;
//- Adapt the context for the current object
@ -161,6 +156,13 @@ protected:
virtual const dictionary& codeDict() const = 0;
//- No copy construct
codedBase(const codedBase&) = delete;
//- No copy assignment
void operator=(const codedBase&) = delete;
public:
//- Runtime type information
@ -169,7 +171,7 @@ public:
// Constructors
//- Construct null
//- Default construct
codedBase() = default;

2
src/OpenFOAM/db/dynamicLibrary/dynamicCode/dynamicCode.C
View File

@ -141,7 +141,7 @@ bool Foam::dynamicCode::resolveTemplates
DynamicList<fileName>& badFiles
)
{
// Try to get template from FOAM_CODESTREAM_TEMPLATES
// Try to get template from FOAM_CODE_TEMPLATES
const fileName templateDir(Foam::getEnv(codeTemplateEnvName));
bool allOkay = true;

4
src/OpenFOAM/db/functionObjects/functionObject/functionObject.C
View File

@ -83,7 +83,7 @@ Foam::autoPtr<Foam::functionObject> Foam::functionObject::New
if (finder.found())
{
const_cast<Time&>(runTime).libs().open
runTime.libs().open
(
dict,
finder.ref().keyword(),
@ -93,7 +93,7 @@ Foam::autoPtr<Foam::functionObject> Foam::functionObject::New
}
// This is the simplified version without compatibility messages
// const_cast<Time&>(runTime).libs().open
// runTime.libs().open
// (
// dict,
// "libs",

2
src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.C
View File

@ -771,7 +771,7 @@ bool Foam::functionObjectList::read()
addProfiling(fo, "functionObjects::read");
const_cast<Time&>(time_).libs().open
time_.libs().open
(
functionsDict,
"libs",

2
src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.C
View File

@ -66,7 +66,7 @@ const
template<class Type>
Foam::dlLibraryTable& Foam::codedFixedValuePointPatchField<Type>::libs() const
{
return const_cast<dlLibraryTable&>(this->db().time().libs());
return this->db().time().libs();
}

4
src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H
View File

@ -106,7 +106,7 @@ class codedFixedValuePointPatchField
public fixedValuePointPatchField<Type>,
protected codedBase
{
// Private data
// Private Data
//- Dictionary contents for the boundary condition
mutable dictionary dict_;
@ -120,7 +120,7 @@ class codedFixedValuePointPatchField
const IOdictionary& dict() const;
//- Get the loaded dynamic libraries
//- Mutable access to the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- Adapt the context for the current object

8
src/OpenFOAM/global/argList/argList.C
View File

@ -854,8 +854,8 @@ Foam::argList::argList
if (strcmp(optName, "lib") == 0)
{
// The '-lib' option:
// Append name(s) to libs_ for later opening
libs_.append(this->getList<fileName>(argi));
// Append name(s) to libs for later opening
libs().append(this->getList<fileName>(argi));
}
else if (strcmp(optName, "debug-switch") == 0)
{
@ -1066,8 +1066,8 @@ void Foam::argList::parse
jobInfo.add("foamBuild", build);
}
// Load additional libraries
libs_.open(bannerEnabled());
// Load additional libraries (verbosity according to banner setting)
libs().open(bannerEnabled());
}

9
src/OpenFOAM/global/argList/argList.H
View File

@ -142,7 +142,7 @@ class argList
HashTable<string> options_;
//- Additional libraries
dlLibraryTable libs_;
mutable dlLibraryTable libs_;
word executable_;
fileName rootPath_;
@ -346,11 +346,8 @@ public:
//- Return the ParRunControl
inline const ParRunControl& parRunControl() const;
//- Access to the loaded libraries
inline const dlLibraryTable& libs() const;
//- Access to the loaded libraries
inline dlLibraryTable& libs();
//- Mutable access to the loaded dynamic libraries
inline dlLibraryTable& libs() const;
//- The number of arguments
inline label size() const noexcept;

10
src/OpenFOAM/global/argList/argListI.H
View File

@ -6,7 +6,7 @@
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2011-2013 OpenFOAM Foundation
Copyright (C) 2017-2019 OpenCFD Ltd.
Copyright (C) 2017-2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@ -112,13 +112,7 @@ inline const Foam::ParRunControl& Foam::argList::parRunControl() const
}
inline const Foam::dlLibraryTable& Foam::argList::libs() const
{
return libs_;
}
inline Foam::dlLibraryTable& Foam::argList::libs()
inline Foam::dlLibraryTable& Foam::argList::libs() const
{
return libs_;
}

6
src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGAgglomerations/GAMGAgglomeration/GAMGAgglomeration.C
View File

@ -308,7 +308,7 @@ const Foam::GAMGAgglomeration& Foam::GAMGAgglomeration::New
controlDict.getOrDefault<word>("agglomerator", "faceAreaPair")
);
const_cast<Time&>(mesh.thisDb().time()).libs().open
mesh.thisDb().time().libs().open
(
controlDict,
"geometricGAMGAgglomerationLibs",
@ -362,7 +362,7 @@ const Foam::GAMGAgglomeration& Foam::GAMGAgglomeration::New
controlDict.getOrDefault<word>("agglomerator", "faceAreaPair")
);
const_cast<Time&>(mesh.thisDb().time()).libs().open
mesh.thisDb().time().libs().open
(
controlDict,
"algebraicGAMGAgglomerationLibs",
@ -408,7 +408,7 @@ Foam::autoPtr<Foam::GAMGAgglomeration> Foam::GAMGAgglomeration::New
controlDict.getOrDefault<word>("agglomerator", "faceAreaPair")
);
const_cast<Time&>(mesh.thisDb().time()).libs().open
mesh.thisDb().time().libs().open
(
controlDict,
"geometricGAMGAgglomerationLibs",

2
src/dynamicFvMesh/dynamicFvMesh/dynamicFvMeshNew.C
View File

@ -58,7 +58,7 @@ Foam::autoPtr<Foam::dynamicFvMesh> Foam::dynamicFvMesh::New(const IOobject& io)
Info<< "Selecting dynamicFvMesh " << modelType << endl;
const_cast<Time&>(io.time()).libs().open
io.time().libs().open
(
dict,
"dynamicFvMeshLibs",

2
src/dynamicMesh/motionSolvers/displacement/codedPoints0/codedPoints0MotionSolver.C
View File

@ -89,7 +89,7 @@ void Foam::codedPoints0MotionSolver::prepare
Foam::dlLibraryTable& Foam::codedPoints0MotionSolver::libs() const
{
return const_cast<Time&>(mesh().time()).libs();
return mesh().time().libs();
}

2
src/dynamicMesh/motionSolvers/displacement/codedPoints0/codedPoints0MotionSolver.H
View File

@ -103,7 +103,7 @@ protected:
// Protected Member Functions
//- Get the loaded dynamic libraries
//- Mutable access to the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- Adapt the context for the current object

2
src/dynamicMesh/motionSolvers/displacement/displacement/displacementMotionSolver.C
View File

@ -94,7 +94,7 @@ Foam::displacementMotionSolver::New
{
Info<< "Selecting motion solver: " << solverTypeName << endl;
const_cast<Time&>(mesh.time()).libs().open
mesh.time().libs().open
(
solverDict,
"motionSolverLibs",

2
src/dynamicMesh/motionSolvers/motionSolver/motionSolver.C
View File

@ -116,7 +116,7 @@ Foam::autoPtr<Foam::motionSolver> Foam::motionSolver::New
Info<< "Selecting motion solver: " << solverName << nl;
const_cast<Time&>(mesh.time()).libs().open
mesh.time().libs().open
(
solverDict,
"motionSolverLibs",

2
src/finiteVolume/cfdTools/general/fvOptions/fvOption.C
View File

@ -79,7 +79,7 @@ Foam::autoPtr<Foam::fv::option> Foam::fv::option::New
Info<< indent
<< "Selecting finite volume options type " << modelType << endl;
const_cast<Time&>(mesh.time()).libs().open
mesh.time().libs().open
(
coeffs,
"libs",

11
src/finiteVolume/expressions/base/fvExprDriver.C
View File

@ -112,7 +112,6 @@ Foam::expressions::fvExprDriver::fvExprDriver
storedVariables_(),
specialVariablesIndex_(-1),
otherMeshName_(),
libs_(),
writer_(nullptr)
{}
@ -128,7 +127,6 @@ Foam::expressions::fvExprDriver::fvExprDriver
storedVariables_(rhs.storedVariables_),
specialVariablesIndex_(rhs.specialVariablesIndex_),
otherMeshName_(),
libs_(),
writer_(nullptr)
{}
@ -165,12 +163,15 @@ bool Foam::expressions::fvExprDriver::readDict
{
expressions::exprDriver::readDict(dict);
// wordList plugins;
// fileNameList plugins;
// if (dict.readIfPresent("functionPlugins", plugins))
// {
// for (const word& plugin : plugins)
// for (const fileName& libName : plugins)
// {
// libs_.open("libswak" + plugin + "FunctionPlugin.so");
// this->runTime().libs().open
// (
// "libswak" + libName + "FunctionPlugin" // verbose = true
// );
// }
// }

4
src/finiteVolume/expressions/base/fvExprDriver.H
View File

@ -69,7 +69,6 @@ SourceFiles
#include "pointMesh.H"
#include "volFields.H"
#include "topoSetSource.H"
#include "dlLibraryTable.H"
#include "runTimeSelectionTables.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
@ -118,9 +117,6 @@ class fvExprDriver
//- The name of the other mesh (if it is to be required)
word otherMeshName_;
//- Additional libraries
dlLibraryTable libs_;
//- Writing and restoring
autoPtr<exprDriverWriter> writer_;

2
src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.C
View File

@ -66,7 +66,7 @@ const Foam::IOdictionary& Foam::codedFixedValueFvPatchField<Type>::dict() const
template<class Type>
Foam::dlLibraryTable& Foam::codedFixedValueFvPatchField<Type>::libs() const
{
return const_cast<dlLibraryTable&>(this->db().time().libs());
return this->db().time().libs();
}

2
src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H
View File

@ -121,7 +121,7 @@ class codedFixedValueFvPatchField
const IOdictionary& dict() const;
//- Get the loaded dynamic libraries
//- Mutable access to the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- Adapt the context for the current object

2
src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.C
View File

@ -65,7 +65,7 @@ const Foam::IOdictionary& Foam::codedMixedFvPatchField<Type>::dict() const
template<class Type>
Foam::dlLibraryTable& Foam::codedMixedFvPatchField<Type>::libs() const
{
return const_cast<dlLibraryTable&>(this->db().time().libs());
return this->db().time().libs();
}

11
src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H
View File

@ -104,7 +104,7 @@ SourceFiles
namespace Foam
{
// Forward declaration of classes
// Forward Declarations
class dynamicCode;
class dynamicCodeContext;
class IOdictionary;
@ -119,7 +119,7 @@ class codedMixedFvPatchField
public mixedFvPatchField<Type>,
public codedBase
{
// Private data
// Private Data
//- Dictionary contents for the boundary condition
mutable dictionary dict_;
@ -133,7 +133,12 @@ class codedMixedFvPatchField
const IOdictionary& dict() const;
//- Get the loaded dynamic libraries
protected:
// Protected Member Functions
//- Mutable access to the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- Adapt the context for the current object

2
src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C
View File

@ -96,7 +96,7 @@ void Foam::functionObjects::codedFunctionObject::prepare
Foam::dlLibraryTable& Foam::functionObjects::codedFunctionObject::libs() const
{
return const_cast<Time&>(time_).libs();
return time_.libs();
}

5
src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
View File

@ -60,6 +60,7 @@ Usage
#{
// Lookup U
const volVectorField& U = mesh().lookupObject<volVectorField>("U");
// Write
mag(U)().write();
#};
@ -99,7 +100,7 @@ class codedFunctionObject
{
protected:
// Protected data
// Protected Data
//- Input dictionary
dictionary dict_;
@ -118,7 +119,7 @@ protected:
// Protected Member Functions
//- Get the loaded dynamic libraries
//- Mutable access to the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- Adapt the context for the current object

2
src/fvOptions/sources/general/codedSource/CodedSource.C
View File

@ -87,7 +87,7 @@ void Foam::fv::CodedSource<Type>::prepare
template<class Type>
Foam::dlLibraryTable& Foam::fv::CodedSource<Type>::libs() const
{
return const_cast<Time&>(mesh_.time()).libs();
return mesh_.time().libs();
}

3
src/fvOptions/sources/general/codedSource/CodedSource.H
View File

@ -126,7 +126,6 @@ class CodedSource
public cellSetOption,
protected codedBase
{
protected:
// Protected Data
@ -143,7 +142,7 @@ protected:
// Protected Member Functions
//- Get the loaded dynamic libraries
//- Mutable access to the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- Adapt the context for the current object

7
src/meshTools/PatchFunction1/CodedField/CodedField.C
View File

@ -27,16 +27,13 @@ License
#include "dynamicCode.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
template<class Type>
Foam::dlLibraryTable&
Foam::PatchFunction1Types::CodedField<Type>::libs() const
{
const dlLibraryTable& timeLibs =
this->patch_.boundaryMesh().mesh().time().libs();
return const_cast<dlLibraryTable&>(timeLibs);
return this->patch_.boundaryMesh().mesh().time().libs();
}

13
src/meshTools/PatchFunction1/CodedField/CodedField.H
View File

@ -109,7 +109,15 @@ class CodedField
// Private Member Functions
//- Get the loaded dynamic libraries
//- Get reference to the underlying Function1
const PatchFunction1<Type>& redirectFunction() const;
protected:
// Protected Member Functions
//- Mutable access to the loaded dynamic libraries
virtual dlLibraryTable& libs() const;
//- Adapt the context for the current object
@ -121,9 +129,6 @@ class CodedField
// Clear the ptr to the redirected object
virtual void clearRedirect() const;
//- Get reference to the underlying Function1
const PatchFunction1<Type>& redirectFunction() const;
// Get the (sub)dictionary to initialize the codeContext
virtual const dictionary& codeDict(const dictionary& fullDict) const;