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

Added abortCalculation function object, exposed Time::stopAtControls

Browse Source 
- still needs fine-tuning (testing) to see if it reacts as anticipated under
  various conditions.
This commit is contained in:
Mark Olesen
2009-11-06 17:18:32 +01:00
parent 33e936a34d
commit 3d9c822022
23 changed files with 522 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObjectFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around writeRegisteredObject to allow them to be
created via the functions list within controlDict.
created via the functions entry within controlDict.
SourceFiles
writeRegisteredObjectFunctionObject.C

2
src/postProcessing/functionObjects/field/fieldAverage/fieldAverageFunctionObject/fieldAverageFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around fieldAverage to allow them to be created
via the functions list within controlDict.
via the functions entry within controlDict.
SourceFiles
fieldAverageFunctionObject.C

2
src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMaxFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around fieldMinMax to allow them to be created via
the functions list within controlDict.
the functions entry within controlDict.
SourceFiles
fieldMinMaxFunctionObject.C

2
src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSourceFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around cellSource to allow it to be
created via the functions list within controlDict.
created via the functions entry within controlDict.
SourceFiles
cellSourceFunctionObject.C

2
src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSourceFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around faceSource to allow it to be
created via the functions list within controlDict.
created via the functions entry within controlDict.
SourceFiles
faceSourceFunctionObject.C

2
src/postProcessing/functionObjects/field/streamLine/streamLineFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around streamLines to allow them to be created via
the functions list within controlDict.
the functions entry within controlDict.
SourceFiles
streamLineFunctionObject.C

2
src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffsFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around forceCoeffs to allow them to be created via
the functions list within controlDict.
the functions entry within controlDict.
SourceFiles
forceCoeffsFunctionObject.C

2
src/postProcessing/functionObjects/forces/forces/forcesFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around forces to allow them to be created via the
functions list within controlDict.
functions entry within controlDict.
SourceFiles
forcesFunctionObject.C

2
src/postProcessing/functionObjects/systemCall/systemCallFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around systemCall to allow them to be created via
the functions list within controlDict.
the functions entry within controlDict.
SourceFiles
systemCallFunctionObject.C

3
src/postProcessing/functionObjects/utilities/Make/files
View File

@ -1,3 +1,6 @@
abortCalculation/abortCalculation.C
abortCalculation/abortCalculationFunctionObject.C
staticPressure/staticPressure.C
staticPressure/staticPressureFunctionObject.C

50
src/postProcessing/functionObjects/utilities/abortCalculation/IOabortCalculation.H Normal file
View File

@ -0,0 +1,50 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2009 OpenCFD Ltd.
\\/ 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 2 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, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Typedef
Foam::IOabortCalculation
Description
Instance of the generic IOOutputFilter for abortCalculation.
\*---------------------------------------------------------------------------*/
#ifndef IOabortCalculation_H
#define IOabortCalculation_H
#include "abortCalculation.H"
#include "IOOutputFilter.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
typedef IOOutputFilter<abortCalculation> IOabortCalculation;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //

159
src/postProcessing/functionObjects/utilities/abortCalculation/abortCalculation.C Normal file
View File

@ -0,0 +1,159 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2009 OpenCFD Ltd.
\\/ 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 2 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, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
\*---------------------------------------------------------------------------*/
#include "abortCalculation.H"
#include "dictionary.H"
#include "error.H"
#include "Time.H"
#include "OSspecific.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
defineTypeNameAndDebug(abortCalculation, 0);
}
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
template<>
const char* Foam::NamedEnum<Foam::abortCalculation::actionType, 3>::names[] =
{
"noWriteNow",
"writeNow",
"nextWrite"
};
const Foam::NamedEnum<Foam::abortCalculation::actionType, 3>
Foam::abortCalculation::actionTypeNames_;
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
void Foam::abortCalculation::removeFile() const
{
if (isFile(abortFile_))
{
rm(abortFile_);
}
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::abortCalculation::abortCalculation
(
const word& name,
const objectRegistry& obr,
const dictionary& dict,
const bool loadFromFiles
)
:
name_(name),
obr_(obr),
abortFile_("$FOAM_CASE/" + name),
action_(nextWrite)
{
abortFile_.expand();
read(dict);
// remove any old files from previous runs
removeFile();
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::abortCalculation::~abortCalculation()
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
void Foam::abortCalculation::read(const dictionary& dict)
{
word actionName;
if (dict.found("action"))
{
action_ = actionTypeNames_.read
(
dict.lookup("action")
);
}
else
{
action_ = nextWrite;
}
if (dict.readIfPresent("fileName", abortFile_))
{
abortFile_.expand();
}
}
void Foam::abortCalculation::execute()
{
if (isFile(abortFile_))
{
switch (action_)
{
case noWriteNow :
obr_.time().stopAt(Time::saNoWriteNow);
Info<< "user requested abort - "
"stop immediately without writing data" << endl;
break;
case writeNow :
obr_.time().stopAt(Time::saWriteNow);
Info<< "user requested abort - "
"stop immediately with writing data" << endl;
break;
case nextWrite :
obr_.time().stopAt(Time::saNextWrite);
Info<< "user requested abort - "
"stop after next data write" << endl;
break;
}
}
}
void Foam::abortCalculation::end()
{
removeFile();
}
void Foam::abortCalculation::write()
{
execute();
}
// ************************************************************************* //

168
src/postProcessing/functionObjects/utilities/abortCalculation/abortCalculation.H Normal file
View File

@ -0,0 +1,168 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2009 OpenCFD Ltd.
\\/ 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 2 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, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::abortCalculation
Description
Watches for presence of the named file in the $FOAM_CASE directory
and aborts the calculation if it is present.
Currently the following action types are supported:
- noWriteNow
- writeNow
- nextWrite
SourceFiles
abortCalculation.C
IOabortCalculation.H
\*---------------------------------------------------------------------------*/
#ifndef abortCalculation_H
#define abortCalculation_H
#include "pointFieldFwd.H"
#include "NamedEnum.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class objectRegistry;
class dictionary;
class mapPolyMesh;
/*---------------------------------------------------------------------------*\
Class abortCalculation Declaration
\*---------------------------------------------------------------------------*/
class abortCalculation
{
public:
// Public data
//- Enumeration defining the type of action
enum actionType
{
noWriteNow, /*!< stop immediately without writing data */
writeNow, /*!< write data and stop immediately */
nextWrite /*!< stop the next time data are written */
};
private:
// Private data
//- Name of the abort file unless otherwise specified
word name_;
const objectRegistry& obr_;
//- The fully-qualified name of the abort file
fileName abortFile_;
//- Action type names
static const NamedEnum<actionType, 3> actionTypeNames_;
//- The type of action
actionType action_;
// Private Member Functions
//- Remove abort file.
void removeFile() const;
//- Disallow default bitwise copy construct
abortCalculation(const abortCalculation&);
//- Disallow default bitwise assignment
void operator=(const abortCalculation&);
public:
//- Runtime type information
TypeName("abort");
// Constructors
//- Construct for given objectRegistry and dictionary.
abortCalculation
(
const word& name,
const objectRegistry&,
const dictionary&,
const bool loadFromFilesUnused = false
);
//- Destructor
virtual ~abortCalculation();
// Member Functions
//- Return name of the abort file
virtual const word& name() const
{
return name_;
}
//- Read the dictionary settings
virtual void read(const dictionary&);
//- Execute, check existence of abort file and take action
virtual void execute();
//- Execute at the final time-loop, used for cleanup
virtual void end();
//- Execute, check existence of abort file and take action
virtual void write();
//- Update for changes of mesh - does nothing
virtual void updateMesh(const mapPolyMesh&)
{}
//- Update for changes of mesh - does nothing
virtual void movePoints(const pointField&)
{}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //

43
src/postProcessing/functionObjects/utilities/abortCalculation/abortCalculationFunctionObject.C Normal file
View File

@ -0,0 +1,43 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2009 OpenCFD Ltd.
\\/ 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 2 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, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
\*---------------------------------------------------------------------------*/
#include "abortCalculationFunctionObject.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
defineNamedTemplateTypeNameAndDebug(abortCalculationFunctionObject, 0);
addToRunTimeSelectionTable
(
functionObject,
abortCalculationFunctionObject,
dictionary
);
}
// ************************************************************************* //

55
src/postProcessing/functionObjects/utilities/abortCalculation/abortCalculationFunctionObject.H Normal file
View File

@ -0,0 +1,55 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2009-2009 OpenCFD Ltd.
\\/ 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 2 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, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Typedef
Foam::abortCalculationFunctionObject
Description
FunctionObject wrapper around abortCalculation to allow it to be created via
the functions entry within controlDict.
SourceFiles
abortCalculationFunctionObject.C
\*---------------------------------------------------------------------------*/
#ifndef abortCalculationFunctionObject_H
#define abortCalculationFunctionObject_H
#include "abortCalculation.H"
#include "OutputFilterFunctionObject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
typedef OutputFilterFunctionObject<abortCalculation>
abortCalculationFunctionObject;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //

2
src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFieldsFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around dsmcFields to allow it to be created via
the functions list within controlDict.
the functions entry within controlDict.
SourceFiles
dsmcFieldsFunctionObject.C

2
src/postProcessing/functionObjects/utilities/staticPressure/staticPressureFunctionObject.H
View File

@ -27,7 +27,7 @@ Typedef
Description
FunctionObject wrapper around staticPressure to allow it to be created via
the functions list within controlDict.
the functions entry within controlDict.
SourceFiles
staticPressureFunctionObject.C