mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
3d5fb08693
- Also fixed bug noted in issue #269 - Previous implementation had all faces together, which made it difficult (impossible) for external applications to figure out which geometry was being referred to. - Provide separate region/patches as follows: // Patch: <regionName> <patchName> For example, // Group: coupleGroup // Patch: heater minY 8( ... ) The region-name is always present, even if there is only one region. - This change is a partial reversion to the behaviour in 2.4.x, except that we can now also handle multi-region geometries. Changing the leading comment from "# " to "// " facilitates parsing of the files with OpenFOAM itself if necessary.
419 lines
12 KiB
C++
419 lines
12 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2015-2016 OpenCFD Ltd.
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify i
|
|
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/>.
|
|
|
|
Class
|
|
Foam::externalCoupledFunctionObject
|
|
|
|
Group
|
|
grpJobControlFunctionObjects
|
|
|
|
Description
|
|
This functionObject provides a simple interface for explicit coupling with
|
|
an external application. The coupling is through plain text files
|
|
where OpenFOAM boundary data is read/written as one line per face
|
|
(data from all processors collated):
|
|
|
|
# Patch: <patch name>
|
|
<fld1> <fld2> .. <fldn> //face0
|
|
<fld1> <fld2> .. <fldn> //face1
|
|
..
|
|
<fld1> <fld2> .. <fldn> //faceN
|
|
|
|
where the actual entries depend on the bc type:
|
|
- mixed: value, snGrad, refValue, refGrad, valueFraction
|
|
- externalCoupledMixed: output of writeData
|
|
- other: value, snGrad
|
|
|
|
These text files are located in a user specified communications directory
|
|
which gets read/written on the master processor only. In the
|
|
communications directory the structure will be
|
|
|
|
<regionsName>/<patchGroup>/<fieldName>.[in|out]
|
|
|
|
(where regionsName is either the name of a single region or a composite
|
|
of multiple region names)
|
|
|
|
At start-up, the boundary creates a lock file, i.e..
|
|
|
|
OpenFOAM.lock
|
|
|
|
... to signal the external source to wait. During the functionObject
|
|
execution the boundary values are written to files (one per region,
|
|
per patch(group), per field), e.g.
|
|
|
|
<regionsName>/<patchGroup>/<fieldName>.out
|
|
|
|
The lock file is then removed, instructing the external source to take
|
|
control of the program execution. When ready, the external program
|
|
should create the return values, e.g. to files
|
|
|
|
<regionsName>/<patchGroup>/<fieldName>.in
|
|
|
|
... and then re-instate the lock file. The functionObject will then
|
|
read these values, apply them to the boundary conditions and pass
|
|
program execution back to OpenFOAM.
|
|
|
|
Example of function object specification:
|
|
\verbatim
|
|
externalCoupled
|
|
{
|
|
type externalCoupled;
|
|
...
|
|
log yes;
|
|
commsDir "${FOAM_CASE}/comms";
|
|
initByExternal yes;
|
|
stateEnd remove; // (remove | done)
|
|
|
|
regions
|
|
{
|
|
"(region1|region0)" // Name of region(s)
|
|
{
|
|
TPatchGroup // Name of patch(group)
|
|
{
|
|
readFields (p); // List of fields to read
|
|
writeFields (T); // List of fields to write
|
|
}
|
|
}
|
|
}
|
|
}
|
|
\endverbatim
|
|
|
|
This reads/writes (on the master processor) the directory:
|
|
comms/region0_region1/TPatchGroup/
|
|
with contents:
|
|
patchPoints (collected points)
|
|
patchFaces (collected faces)
|
|
p.in (input file of p, written by external application)
|
|
T.out (output file of T, written by OpenFOAM)
|
|
|
|
The patchPoints/patchFaces files denote the (collated) geometry
|
|
which will be written if it does not exist yet or can be written as
|
|
a preprocessing step using the createExternalCoupledPatchGeometry
|
|
application.
|
|
|
|
SourceFiles
|
|
externalCoupledFunctionObject.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef externalCoupledFunctionObject_H
|
|
#define externalCoupledFunctionObject_H
|
|
|
|
#include "functionObject.H"
|
|
#include "DynamicList.H"
|
|
#include "wordReList.H"
|
|
#include "scalarField.H"
|
|
#include "NamedEnum.H"
|
|
#include "Switch.H"
|
|
#include "UPtrList.H"
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of classes
|
|
class dictionary;
|
|
class polyMesh;
|
|
class mapPolyMesh;
|
|
class IFstream;
|
|
class fvMesh;
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class externalCoupledFunctionObject Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class externalCoupledFunctionObject
|
|
:
|
|
public functionObject
|
|
{
|
|
public:
|
|
|
|
// Public data types
|
|
|
|
//- Lockfile state on termination
|
|
enum stateEnd
|
|
{
|
|
REMOVE, //!< Remove lock file on end
|
|
DONE //!< Lock file contains status=done on end
|
|
};
|
|
|
|
private:
|
|
|
|
//- State end names
|
|
static const NamedEnum<stateEnd, 2> stateEndNames_;
|
|
|
|
|
|
// Private data
|
|
|
|
//- Reference to the time database
|
|
const Time& time_;
|
|
|
|
//- Switch for the execution - defaults to 'yes/on'
|
|
Switch enabled_;
|
|
|
|
//- Path to communications directory
|
|
fileName commsDir_;
|
|
|
|
//- Interval time between checking for return data [s]
|
|
label waitInterval_;
|
|
|
|
//- Time out time [s]
|
|
label timeOut_;
|
|
|
|
//- Calculation frequency
|
|
label calcFrequency_;
|
|
|
|
//- Flag to indicate values are initialised by external application
|
|
bool initByExternal_;
|
|
|
|
//- Lockfile state on termination
|
|
stateEnd stateEnd_;
|
|
|
|
//- Log flag
|
|
bool log_;
|
|
|
|
//- Names of (composite) regions
|
|
DynamicList<word> regionGroupNames_;
|
|
|
|
// Per (composite) region the names of the regions
|
|
DynamicList<wordList> regionGroupRegions_;
|
|
|
|
// Per (composite) region the indices of the group information
|
|
HashTable<labelList> regionToGroups_;
|
|
|
|
// Per group the names of the patches/patchGroups
|
|
DynamicList<wordRe> groupNames_;
|
|
|
|
// Per group the names of the fields to read
|
|
DynamicList<wordList> groupReadFields_;
|
|
|
|
// Per group the names of the fields to write
|
|
DynamicList<wordList> groupWriteFields_;
|
|
|
|
//- Initialised flag
|
|
bool initialised_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Return the file path to the communications directory for the region
|
|
static fileName groupDir
|
|
(
|
|
const fileName& commsDir,
|
|
const word& regionsName,
|
|
const wordRe& groupName
|
|
);
|
|
|
|
//- Return the file path to the base communications directory
|
|
fileName baseDir() const;
|
|
|
|
//- Return the file path to the lock file
|
|
fileName lockFile() const;
|
|
|
|
|
|
//- Create lock file to indicate that OpenFOAM is in charge
|
|
void useMaster() const;
|
|
|
|
//- Remove lock file to indicate that the external program is in charge
|
|
void useSlave() const;
|
|
|
|
//- Remove lock file or status=done in lock.
|
|
void cleanup() const;
|
|
|
|
//- Remove files written by OpenFOAM
|
|
void removeWriteFiles() const;
|
|
|
|
//- Remove files written by external code
|
|
void removeReadFiles() const;
|
|
|
|
//- Wait for indication that the external program has supplied input
|
|
// (ie, for the lock file to reappear).
|
|
void waitForSlave() const;
|
|
|
|
|
|
//- Read data for a single region, single field
|
|
template<class Type>
|
|
bool readData
|
|
(
|
|
const UPtrList<const fvMesh>& meshes,
|
|
const wordRe& groupName,
|
|
const word& fieldName
|
|
);
|
|
//- Read data for all regions, all fields
|
|
void readData();
|
|
|
|
//- Write data for a single region, single field
|
|
template<class Type>
|
|
bool writeData
|
|
(
|
|
const UPtrList<const fvMesh>& meshes,
|
|
const wordRe& groupName,
|
|
const word& fieldName
|
|
) const;
|
|
|
|
//- Write data for all regions, all fields
|
|
void writeData() const;
|
|
|
|
void initialise();
|
|
|
|
//- Read (and distribute) scalar columns from stream. Every processor
|
|
// gets nRows (= patch size) of these. Note: could make its argument
|
|
// ISstream& but then would need additional logic to construct valid
|
|
// stream on all processors.
|
|
void readColumns
|
|
(
|
|
const label nRows,
|
|
const label nColumns,
|
|
autoPtr<IFstream>& masterFilePtr,
|
|
List<scalarField>& data
|
|
) const;
|
|
|
|
//- Read (and distribute) lines from stream. Every processor
|
|
// gets nRows (= patch size) of these. Data kept as stream (instead
|
|
// of strings) for ease of interfacing to readData routines that take
|
|
// an Istream.
|
|
void readLines
|
|
(
|
|
const label nRows,
|
|
autoPtr<IFstream>& masterFilePtr,
|
|
OStringStream& data
|
|
) const;
|
|
|
|
//- Helper: append data from all processors onto master
|
|
template<class Type>
|
|
static tmp<Field<Type>> gatherAndCombine(const Field<Type>& fld);
|
|
|
|
static void checkOrder(const wordList&);
|
|
|
|
//- Disallow default bitwise copy construc
|
|
externalCoupledFunctionObject(const externalCoupledFunctionObject&);
|
|
|
|
//- Disallow default bitwise assignmen
|
|
void operator=(const externalCoupledFunctionObject&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("externalCoupled");
|
|
|
|
//- Name of lock file (normally 'OpenFOAM.lock')
|
|
static word lockName;
|
|
|
|
//- Name of patch key, e.g. '// Patch:' when looking for start of patch data
|
|
static string patchKey;
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct given time and dictionary
|
|
externalCoupledFunctionObject
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary& dict
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~externalCoupledFunctionObject();
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
//- Return the enabled flag
|
|
virtual bool enabled() const
|
|
{
|
|
return enabled_;
|
|
}
|
|
|
|
|
|
// Function object control
|
|
|
|
//- Switch the function object on
|
|
virtual void on();
|
|
|
|
//- Switch the function object off
|
|
virtual void off();
|
|
|
|
//- Called at the start of the time-loop
|
|
virtual bool start();
|
|
|
|
//- Called at each ++ or += of the time-loop
|
|
virtual bool execute(const bool forceWrite);
|
|
|
|
//- Called when Time::run() determines that the time-loop exits
|
|
virtual bool end();
|
|
|
|
//- Called when time was set at the end of the Time::operator++
|
|
virtual bool timeSet();
|
|
|
|
//- Called at the end of Time::adjustDeltaT() if adjustTime is true
|
|
virtual bool adjustTimeStep();
|
|
|
|
//- Read and set the function object if its data have changed
|
|
virtual bool read(const dictionary&);
|
|
|
|
//- Update for changes of mesh
|
|
virtual void updateMesh(const mapPolyMesh& mpm);
|
|
|
|
//- Update for changes of mesh
|
|
virtual void movePoints(const polyMesh& mesh);
|
|
|
|
|
|
// Other
|
|
|
|
//- Create single name by appending words (in sorted order),
|
|
// separated by '_'
|
|
static word compositeName(const wordList&);
|
|
|
|
//- Write geometry for the group as region/patch
|
|
static void writeGeometry
|
|
(
|
|
const UPtrList<const fvMesh>& meshes,
|
|
const fileName& commsDir,
|
|
const wordRe& groupName
|
|
);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
# include "externalCoupledFunctionObjectTemplates.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|