zhyang-dev/OpenFOAM-5.x
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

functionObjects: rewritten to all be derived from 'functionObject'

Browse Source 
- Avoids the need for the 'OutputFilterFunctionObject' wrapper
  - Time-control for execution and writing is now provided by the
    'timeControlFunctionObject' which instantiates the processing
    'functionObject' and controls its operation.
  - Alternative time-control functionObjects can now be written and
    selected at run-time without the need to compile wrapped version of
    EVERY existing functionObject which would have been required in the
    old structure.
  - The separation of 'execute' and 'write' functions is now formalized in the
    'functionObject' base-class and all derived classes implement the
    two functions.
  - Unnecessary implementations of functions with appropriate defaults
    in the 'functionObject' base-class have been removed reducing
    clutter and simplifying implementation of new functionObjects.
  - The 'coded' 'functionObject' has also been updated, simplified and tested.
  - Further simplification is now possible by creating some general
    intermediate classes derived from 'functionObject'.
This commit is contained in:
Henry Weller
2016-05-15 16:40:01 +01:00
parent 1441f8cab0
commit 91aba2db2e
230 changed files with 2731 additions and 8756 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
src/postProcessing/functionObjects/utilities/systemCall/systemCall.C
View File

@ -26,6 +26,7 @@ License
#include "systemCall.H"
#include "Time.H"
#include "dynamicCode.H"
#include "addToRunTimeSelectionTable.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
@ -34,6 +35,13 @@ namespace Foam
namespace functionObjects
{
defineTypeNameAndDebug(systemCall, 0);
addToRunTimeSelectionTable
(
functionObject,
systemCall,
dictionary
);
}
}
@ -43,12 +51,11 @@ namespace functionObjects
Foam::functionObjects::systemCall::systemCall
(
const word& name,
const objectRegistry&,
const dictionary& dict,
const bool
const Time&,
const dictionary& dict
)
:
name_(name),
functionObject(name),
executeCalls_(),
endCalls_(),
writeCalls_()
@ -65,7 +72,7 @@ Foam::functionObjects::systemCall::~systemCall()
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
void Foam::functionObjects::systemCall::read(const dictionary& dict)
bool Foam::functionObjects::systemCall::read(const dictionary& dict)
{
dict.readIfPresent("executeCalls", executeCalls_);
dict.readIfPresent("endCalls", endCalls_);
@ -93,37 +100,41 @@ void Foam::functionObjects::systemCall::read(const dictionary& dict)
<< " $WM_PROJECT_DIR/etc/controlDict" << nl << nl
<< exit(FatalError);
}
return true;
}
void Foam::functionObjects::systemCall::execute()
bool Foam::functionObjects::systemCall::execute(const bool postProcess)
{
forAll(executeCalls_, callI)
{
Foam::system(executeCalls_[callI]);
}
return true;
}
void Foam::functionObjects::systemCall::end()
bool Foam::functionObjects::systemCall::end()
{
forAll(endCalls_, callI)
{
Foam::system(endCalls_[callI]);
}
return true;
}
void Foam::functionObjects::systemCall::timeSet()
{}
void Foam::functionObjects::systemCall::write()
bool Foam::functionObjects::systemCall::write(const bool postProcess)
{
forAll(writeCalls_, callI)
{
Foam::system(writeCalls_[callI]);
}
return true;
}

48
src/postProcessing/functionObjects/utilities/systemCall/systemCall.H
View File

@ -76,7 +76,7 @@ Note
SeeAlso
Foam::functionObject
Foam::OutputFilterFunctionObject
Foam::functionObjects::timeControl
SourceFiles
systemCall.C
@ -86,19 +86,13 @@ SourceFiles
#ifndef functionObjects_systemCall_H
#define functionObjects_systemCall_H
#include "functionObject.H"
#include "stringList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class objectRegistry;
class dictionary;
class polyMesh;
class mapPolyMesh;
namespace functionObjects
{
@ -107,14 +101,13 @@ namespace functionObjects
\*---------------------------------------------------------------------------*/
class systemCall
:
public functionObject
{
protected:
// Private data
//- Name of this set of system calls
word name_;
//- List of calls to execute - every step
stringList executeCalls_;
@ -144,14 +137,12 @@ public:
// Constructors
//- Construct for given objectRegistry and dictionary.
// Allow the possibility to load fields from files
//- Construct from Time and dictionary
systemCall
(
const word& name,
const objectRegistry& unused,
const dictionary&,
const bool loadFromFilesUnused = false
const Time& runTime,
const dictionary& dict
);
@ -161,34 +152,17 @@ public:
// Member Functions
//- Return name of the system call set
virtual const word& name() const
{
return name_;
}
//- Read the system calls
virtual void read(const dictionary&);
virtual bool read(const dictionary&);
//- Execute the "executeCalls" at each time-step
virtual void execute();
virtual bool execute(const bool postProcess = false);
//- Execute the "endCalls" at the final time-loop
virtual void end();
//- Called when time was set at the end of the Time::operator++
virtual void timeSet();
virtual bool end();
//- Write, execute the "writeCalls"
virtual void write();
//- Update for changes of mesh
virtual void updateMesh(const mapPolyMesh&)
{}
//- Update for changes of mesh
virtual void movePoints(const polyMesh&)
{}
virtual bool write(const bool postProcess = false);
};

42
src/postProcessing/functionObjects/utilities/systemCall/systemCallFunctionObject.C
View File

@ -1,42 +0,0 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 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 "systemCallFunctionObject.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
defineNamedTemplateTypeNameAndDebug(systemCallFunctionObject, 0);
addToRunTimeSelectionTable
(
functionObject,
systemCallFunctionObject,
dictionary
);
}
// ************************************************************************* //

54
src/postProcessing/functionObjects/utilities/systemCall/systemCallFunctionObject.H
View File

@ -1,54 +0,0 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 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/>.
Typedef
Foam::systemCallFunctionObject
Description
FunctionObject wrapper around systemCall to allow them to be created via
the functions entry within controlDict.
SourceFiles
systemCallFunctionObject.C
\*---------------------------------------------------------------------------*/
#ifndef systemCallFunctionObject_H
#define systemCallFunctionObject_H
#include "systemCall.H"
#include "OutputFilterFunctionObject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
typedef OutputFilterFunctionObject<functionObjects::systemCall>
systemCallFunctionObject;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //