mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
8d5800c5f8
- moved control to functionObject (from bc) - this allows multi-region support - see heatTransfer/chtMultiRegionFoam/externalCoupledMultiRegionHeater tut - generalisation of streamed reading/writing of specialised bcs
1089 lines
28 KiB
C
1089 lines
28 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2015 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 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 "externalCoupledFunctionObject.H"
|
|
#include "addToRunTimeSelectionTable.H"
|
|
#include "OSspecific.H"
|
|
#include "IFstream.H"
|
|
#include "OFstream.H"
|
|
#include "volFields.H"
|
|
#include "globalIndex.H"
|
|
#include "fvMesh.H"
|
|
#include "DynamicField.H"
|
|
|
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
defineTypeNameAndDebug(externalCoupledFunctionObject, 0);
|
|
|
|
addToRunTimeSelectionTable
|
|
(
|
|
functionObject,
|
|
externalCoupledFunctionObject,
|
|
dictionary
|
|
);
|
|
}
|
|
|
|
Foam::word Foam::externalCoupledFunctionObject::lockName = "OpenFOAM";
|
|
|
|
Foam::string Foam::externalCoupledFunctionObject::patchKey = "# Patch: ";
|
|
|
|
|
|
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
|
|
|
|
Foam::fileName Foam::externalCoupledFunctionObject::baseDir() const
|
|
{
|
|
fileName result(commsDir_);
|
|
result.clean();
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
Foam::fileName Foam::externalCoupledFunctionObject::groupDir
|
|
(
|
|
const fileName& commsDir,
|
|
const word& regionGroupName,
|
|
const wordRe& groupName
|
|
)
|
|
{
|
|
fileName result
|
|
(
|
|
commsDir
|
|
/regionGroupName
|
|
/string::validate<fileName>(groupName)
|
|
);
|
|
result.clean();
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
Foam::fileName Foam::externalCoupledFunctionObject::lockFile() const
|
|
{
|
|
return fileName(baseDir()/(lockName + ".lock"));
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::createLockFile() const
|
|
{
|
|
if (!Pstream::master())
|
|
{
|
|
return;
|
|
}
|
|
|
|
const fileName fName(lockFile());
|
|
IFstream is(fName);
|
|
|
|
// Only create lock file if it doesn't already exist
|
|
if (!is.good())
|
|
{
|
|
if (log_) Info<< type() << ": creating lock file" << endl;
|
|
|
|
OFstream os(fName);
|
|
os << "lock file";
|
|
os.flush();
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::removeLockFile() const
|
|
{
|
|
if (!Pstream::master())
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (log_) Info<< type() << ": removing lock file" << endl;
|
|
|
|
rm(lockFile());
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::removeReadFiles() const
|
|
{
|
|
if (!Pstream::master())
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (log_) Info<< type() << ": removing all read files" << endl;
|
|
|
|
forAll(regionGroupNames_, regionI)
|
|
{
|
|
const word& compName = regionGroupNames_[regionI];
|
|
|
|
const labelList& groups = regionToGroups_[compName];
|
|
forAll(groups, i)
|
|
{
|
|
label groupI = groups[i];
|
|
const wordRe& groupName = groupNames_[groupI];
|
|
|
|
forAll(groupReadFields_[groupI], fieldI)
|
|
{
|
|
const word& fieldName = groupReadFields_[groupI][fieldI];
|
|
rm
|
|
(
|
|
groupDir(commsDir_, compName, groupName)
|
|
/ fieldName + ".in"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::removeWriteFiles() const
|
|
{
|
|
if (!Pstream::master())
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (log_) Info<< type() << ": removing all write files" << endl;
|
|
|
|
forAll(regionGroupNames_, regionI)
|
|
{
|
|
const word& compName = regionGroupNames_[regionI];
|
|
|
|
const labelList& groups = regionToGroups_[compName];
|
|
forAll(groups, i)
|
|
{
|
|
label groupI = groups[i];
|
|
const wordRe& groupName = groupNames_[groupI];
|
|
|
|
forAll(groupReadFields_[groupI], fieldI)
|
|
{
|
|
const word& fieldName = groupReadFields_[groupI][fieldI];
|
|
rm
|
|
(
|
|
groupDir(commsDir_, compName, groupName)
|
|
/ fieldName + ".out"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::wait() const
|
|
{
|
|
const fileName fName(lockFile());
|
|
label found = 0;
|
|
label totalTime = 0;
|
|
|
|
if (log_) Info<< type() << ": beginning wait for lock file " << fName << nl;
|
|
|
|
while (found == 0)
|
|
{
|
|
if (Pstream::master())
|
|
{
|
|
if (totalTime > timeOut_)
|
|
{
|
|
FatalErrorIn
|
|
(
|
|
"void "
|
|
"Foam::externalCoupledFunctionObject::wait() "
|
|
"const"
|
|
)
|
|
<< "Wait time exceeded time out time of " << timeOut_
|
|
<< " s" << abort(FatalError);
|
|
}
|
|
|
|
IFstream is(fName);
|
|
|
|
if (is.good())
|
|
{
|
|
found++;
|
|
|
|
if (log_)
|
|
{
|
|
Info<< type() << ": found lock file " << fName << endl;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
sleep(waitInterval_);
|
|
totalTime += waitInterval_;
|
|
|
|
if (log_)
|
|
{
|
|
Info<< type() << ": wait time = " << totalTime << endl;
|
|
}
|
|
}
|
|
}
|
|
|
|
// prevent other procs from racing ahead
|
|
reduce(found, sumOp<label>());
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::readColumns
|
|
(
|
|
const label nRows,
|
|
const label nColumns,
|
|
autoPtr<IFstream>& masterFilePtr,
|
|
List<scalarField>& data
|
|
) const
|
|
{
|
|
// Get sizes for all processors
|
|
const globalIndex globalFaces(nRows);
|
|
|
|
PstreamBuffers pBufs(Pstream::nonBlocking);
|
|
if (Pstream::master())
|
|
{
|
|
string line;
|
|
|
|
// Read data from file and send to destination processor
|
|
|
|
for (label procI = 0; procI < Pstream::nProcs(); procI++)
|
|
{
|
|
// Temporary storage
|
|
List<scalarField> values(nColumns);
|
|
|
|
// Number of rows to read for processor procI
|
|
label procNRows = globalFaces.localSize(procI);
|
|
|
|
forAll(values, columnI)
|
|
{
|
|
values[columnI].setSize(procNRows);
|
|
}
|
|
|
|
for (label rowI = 0; rowI < procNRows; rowI++)
|
|
{
|
|
// Get a line
|
|
do
|
|
{
|
|
if (!masterFilePtr().good())
|
|
{
|
|
FatalIOErrorIn
|
|
(
|
|
"externalCoupledFunctionObject::readColumns()",
|
|
masterFilePtr()
|
|
) << "Trying to read data for processor " << procI
|
|
<< " row " << rowI
|
|
<< ". Does your file have as many rows as there are"
|
|
<< " patch faces (" << globalFaces.size()
|
|
<< ") ?" << exit(FatalIOError);
|
|
}
|
|
|
|
masterFilePtr().getLine(line);
|
|
} while (line.empty() || line[0] == '#');
|
|
|
|
IStringStream lineStr(line);
|
|
|
|
for (label columnI = 0; columnI < nColumns; columnI++)
|
|
{
|
|
lineStr >> values[columnI][rowI];
|
|
}
|
|
}
|
|
|
|
// Send to procI
|
|
UOPstream str(procI, pBufs);
|
|
str << values;
|
|
}
|
|
}
|
|
pBufs.finishedSends();
|
|
|
|
// Read from PstreamBuffers
|
|
UIPstream str(Pstream::masterNo(), pBufs);
|
|
str >> data;
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::readLines
|
|
(
|
|
const label nRows,
|
|
autoPtr<IFstream>& masterFilePtr,
|
|
OStringStream& lines
|
|
) const
|
|
{
|
|
// Get sizes for all processors
|
|
const globalIndex globalFaces(nRows);
|
|
|
|
PstreamBuffers pBufs(Pstream::nonBlocking);
|
|
|
|
if (Pstream::master())
|
|
{
|
|
string line;
|
|
|
|
// Read line from file and send to destination processor
|
|
|
|
for (label procI = 0; procI < Pstream::nProcs(); procI++)
|
|
{
|
|
// Number of rows to read for processor procI
|
|
label procNRows = globalFaces.localSize(procI);
|
|
|
|
UOPstream toProc(procI, pBufs);
|
|
|
|
for (label rowI = 0; rowI < procNRows; rowI++)
|
|
{
|
|
// Get a line
|
|
do
|
|
{
|
|
if (!masterFilePtr().good())
|
|
{
|
|
FatalIOErrorIn
|
|
(
|
|
"externalCoupledFunctionObject::readColumns()",
|
|
masterFilePtr()
|
|
) << "Trying to read data for processor " << procI
|
|
<< " row " << rowI
|
|
<< ". Does your file have as many rows as there are"
|
|
<< " patch faces (" << globalFaces.size()
|
|
<< ") ?" << exit(FatalIOError);
|
|
}
|
|
|
|
masterFilePtr().getLine(line);
|
|
} while (line.empty() || line[0] == '#');
|
|
|
|
// Send line to the destination processor
|
|
toProc << line;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
pBufs.finishedSends();
|
|
|
|
// Read lines from PstreamBuffers
|
|
UIPstream str(Pstream::masterNo(), pBufs);
|
|
for (label rowI = 0; rowI < nRows; rowI++)
|
|
{
|
|
string line(str);
|
|
lines << line.c_str() << nl;
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::writeGeometry
|
|
(
|
|
const UPtrList<const fvMesh>& meshes,
|
|
const fileName& commsDir,
|
|
const wordRe& groupName
|
|
)
|
|
{
|
|
wordList regionNames(meshes.size());
|
|
forAll(meshes, i)
|
|
{
|
|
regionNames[i] = meshes[i].dbDir();
|
|
}
|
|
|
|
// Make sure meshes are provided in sorted order
|
|
checkOrder(regionNames);
|
|
|
|
fileName dir(groupDir(commsDir, compositeName(regionNames), groupName));
|
|
|
|
//if (log_)
|
|
{
|
|
Info<< typeName << ": writing geometry to " << dir << endl;
|
|
}
|
|
|
|
autoPtr<OFstream> osPointsPtr;
|
|
autoPtr<OFstream> osFacesPtr;
|
|
if (Pstream::master())
|
|
{
|
|
mkDir(dir);
|
|
osPointsPtr.reset(new OFstream(dir/"patchPoints"));
|
|
osFacesPtr.reset(new OFstream(dir/"patchFaces"));
|
|
}
|
|
|
|
|
|
DynamicList<face> allMeshesFaces;
|
|
DynamicField<point> allMeshesPoints;
|
|
|
|
forAll(meshes, meshI)
|
|
{
|
|
const fvMesh& mesh = meshes[meshI];
|
|
|
|
const labelList patchIDs
|
|
(
|
|
mesh.boundaryMesh().patchSet
|
|
(
|
|
List<wordRe>(1, groupName)
|
|
).sortedToc()
|
|
);
|
|
|
|
// Count faces
|
|
label nFaces = 0;
|
|
forAll(patchIDs, i)
|
|
{
|
|
nFaces += mesh.boundaryMesh()[patchIDs[i]].size();
|
|
}
|
|
|
|
// Collect faces
|
|
DynamicList<label> allFaceIDs(nFaces);
|
|
forAll(patchIDs, i)
|
|
{
|
|
const polyPatch& p = mesh.boundaryMesh()[patchIDs[i]];
|
|
|
|
forAll(p, pI)
|
|
{
|
|
allFaceIDs.append(p.start()+pI);
|
|
}
|
|
}
|
|
|
|
// Construct overall patch
|
|
indirectPrimitivePatch allPatch
|
|
(
|
|
IndirectList<face>(mesh.faces(), allFaceIDs),
|
|
mesh.points()
|
|
);
|
|
|
|
labelList pointToGlobal;
|
|
labelList uniquePointIDs;
|
|
mesh.globalData().mergePoints
|
|
(
|
|
allPatch.meshPoints(),
|
|
allPatch.meshPointMap(),
|
|
pointToGlobal,
|
|
uniquePointIDs
|
|
);
|
|
|
|
label procI = Pstream::myProcNo();
|
|
|
|
List<pointField> collectedPoints(Pstream::nProcs());
|
|
collectedPoints[procI] = pointField(mesh.points(), uniquePointIDs);
|
|
Pstream::gatherList(collectedPoints);
|
|
|
|
List<faceList> collectedFaces(Pstream::nProcs());
|
|
faceList& patchFaces = collectedFaces[procI];
|
|
patchFaces = allPatch.localFaces();
|
|
forAll(patchFaces, faceI)
|
|
{
|
|
inplaceRenumber(pointToGlobal, patchFaces[faceI]);
|
|
}
|
|
Pstream::gatherList(collectedFaces);
|
|
|
|
if (Pstream::master())
|
|
{
|
|
// Append and renumber
|
|
label nPoints = allMeshesPoints.size();
|
|
|
|
forAll(collectedPoints, procI)
|
|
{
|
|
allMeshesPoints.append(collectedPoints[procI]);
|
|
|
|
}
|
|
face newFace;
|
|
forAll(collectedFaces, procI)
|
|
{
|
|
const faceList& procFaces = collectedFaces[procI];
|
|
|
|
forAll(procFaces, faceI)
|
|
{
|
|
const face& f = procFaces[faceI];
|
|
|
|
newFace.setSize(f.size());
|
|
forAll(f, fp)
|
|
{
|
|
newFace[fp] = f[fp]+nPoints;
|
|
}
|
|
allMeshesFaces.append(newFace);
|
|
}
|
|
|
|
nPoints += collectedPoints[procI].size();
|
|
}
|
|
}
|
|
|
|
//if (log_)
|
|
{
|
|
Info<< typeName << ": for mesh " << mesh.name()
|
|
<< " writing " << allMeshesPoints.size() << " points to "
|
|
<< osPointsPtr().name() << endl;
|
|
Info<< typeName << ": for mesh " << mesh.name()
|
|
<< " writing " << allMeshesFaces.size() << " faces to "
|
|
<< osFacesPtr().name() << endl;
|
|
}
|
|
}
|
|
|
|
// Write points
|
|
if (osPointsPtr.valid())
|
|
{
|
|
osPointsPtr() << allMeshesPoints << endl;
|
|
}
|
|
|
|
// Write faces
|
|
if (osFacesPtr.valid())
|
|
{
|
|
osFacesPtr() << allMeshesFaces << endl;
|
|
}
|
|
}
|
|
|
|
|
|
Foam::word Foam::externalCoupledFunctionObject::compositeName
|
|
(
|
|
const wordList& regionNames
|
|
)
|
|
{
|
|
if (regionNames.size() == 0)
|
|
{
|
|
FatalErrorIn
|
|
(
|
|
"externalCoupledFunctionObject::compositeName(const wordList&)"
|
|
) << "Empty regionNames" << abort(FatalError);
|
|
return word::null;
|
|
}
|
|
else if (regionNames.size() == 1)
|
|
{
|
|
if (regionNames[0] == polyMesh::defaultRegion)
|
|
{
|
|
// For compatibility with single region cases suppress single
|
|
// region name
|
|
return word("");
|
|
}
|
|
else
|
|
{
|
|
return regionNames[0];
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Enforce lexical ordering
|
|
checkOrder(regionNames);
|
|
|
|
word composite(regionNames[0]);
|
|
for (label i = 1; i < regionNames.size(); i++)
|
|
{
|
|
composite += "_" + regionNames[i];
|
|
}
|
|
|
|
return composite;
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::checkOrder
|
|
(
|
|
const wordList& regionNames
|
|
)
|
|
{
|
|
labelList order;
|
|
sortedOrder(regionNames, order);
|
|
if (order != identity(regionNames.size()))
|
|
{
|
|
FatalErrorIn
|
|
(
|
|
"externalCoupledFunctionObject::checkOrder(const wordList&)"
|
|
) << "regionNames " << regionNames << " not in alphabetical order :"
|
|
<< order << exit(FatalError);
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::readData()
|
|
{
|
|
forAll(regionGroupNames_, regionI)
|
|
{
|
|
const word& compName = regionGroupNames_[regionI];
|
|
const wordList& regionNames = regionGroupRegions_[regionI];
|
|
|
|
// Get the meshes for the region-group
|
|
UPtrList<const fvMesh> meshes(regionNames.size());
|
|
forAll(regionNames, j)
|
|
{
|
|
const word& regionName = regionNames[j];
|
|
meshes.set(j, &time_.lookupObject<fvMesh>(regionName));
|
|
}
|
|
|
|
const labelList& groups = regionToGroups_[compName];
|
|
|
|
forAll(groups, i)
|
|
{
|
|
label groupI = groups[i];
|
|
const wordRe& groupName = groupNames_[groupI];
|
|
const wordList& fieldNames = groupReadFields_[groupI];
|
|
|
|
forAll(fieldNames, fieldI)
|
|
{
|
|
const word& fieldName = fieldNames[fieldI];
|
|
|
|
bool ok = readData<scalar>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
ok = ok || readData<vector>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
ok = ok || readData<sphericalTensor>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
ok = ok || readData<symmTensor>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
ok = ok || readData<tensor>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
|
|
if (!ok)
|
|
{
|
|
WarningIn
|
|
(
|
|
"void Foam::externalCoupledFunctionObject::readData()"
|
|
)
|
|
<< "Field " << fieldName << " in regions " << compName
|
|
<< " was not found." << endl;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::writeData() const
|
|
{
|
|
forAll(regionGroupNames_, regionI)
|
|
{
|
|
const word& compName = regionGroupNames_[regionI];
|
|
const wordList& regionNames = regionGroupRegions_[regionI];
|
|
|
|
// Get the meshes for the region-group
|
|
UPtrList<const fvMesh> meshes(regionNames.size());
|
|
forAll(regionNames, j)
|
|
{
|
|
const word& regionName = regionNames[j];
|
|
meshes.set(j, &time_.lookupObject<fvMesh>(regionName));
|
|
}
|
|
|
|
const labelList& groups = regionToGroups_[compName];
|
|
|
|
forAll(groups, i)
|
|
{
|
|
label groupI = groups[i];
|
|
const wordRe& groupName = groupNames_[groupI];
|
|
const wordList& fieldNames = groupWriteFields_[groupI];
|
|
|
|
forAll(fieldNames, fieldI)
|
|
{
|
|
const word& fieldName = fieldNames[fieldI];
|
|
|
|
bool ok = writeData<scalar>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
ok = ok || writeData<vector>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
ok = ok || writeData<sphericalTensor>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
ok = ok || writeData<symmTensor>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
ok = ok || writeData<tensor>
|
|
(
|
|
meshes,
|
|
groupName,
|
|
fieldName
|
|
);
|
|
|
|
if (!ok)
|
|
{
|
|
WarningIn
|
|
(
|
|
"void Foam::externalCoupledFunctionObject::writeData()"
|
|
)
|
|
<< "Field " << fieldName << " in regions " << compName
|
|
<< " was not found." << endl;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::initialise()
|
|
{
|
|
if (initialised_)
|
|
{
|
|
return;
|
|
}
|
|
|
|
// Write the geometry if not already there
|
|
forAll(regionGroupRegions_, i)
|
|
{
|
|
const word& compName = regionGroupNames_[i];
|
|
const wordList& regionNames = regionGroupRegions_[i];
|
|
|
|
// Get the meshes for the region-group
|
|
UPtrList<const fvMesh> meshes(regionNames.size());
|
|
forAll(regionNames, j)
|
|
{
|
|
const word& regionName = regionNames[j];
|
|
meshes.set(j, &time_.lookupObject<fvMesh>(regionName));
|
|
}
|
|
|
|
const labelList& groups = regionToGroups_[compName];
|
|
|
|
forAll(groups, i)
|
|
{
|
|
label groupI = groups[i];
|
|
const wordRe& groupName = groupNames_[groupI];
|
|
|
|
bool exists = false;
|
|
if (Pstream::master())
|
|
{
|
|
fileName dir(groupDir(commsDir_, compName, groupName));
|
|
|
|
exists =
|
|
isFile(dir/"patchPoints")
|
|
|| isFile(dir/"patchFaces");
|
|
}
|
|
|
|
if (!returnReduce(exists, orOp<bool>()))
|
|
{
|
|
writeGeometry(meshes, commsDir_, groupName);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (initByExternal_)
|
|
{
|
|
// Wait for initial data to be made available
|
|
wait();
|
|
|
|
// Eead data passed back from external source
|
|
readData();
|
|
}
|
|
|
|
initialised_ = true;
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
Foam::externalCoupledFunctionObject::externalCoupledFunctionObject
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary& dict
|
|
)
|
|
:
|
|
functionObject(name),
|
|
time_(runTime),
|
|
enabled_(true),
|
|
initialised_(false)
|
|
{
|
|
read(dict);
|
|
|
|
if (Pstream::master())
|
|
{
|
|
mkDir(baseDir());
|
|
}
|
|
|
|
if (!initByExternal_)
|
|
{
|
|
createLockFile();
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
Foam::externalCoupledFunctionObject::~externalCoupledFunctionObject()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
void Foam::externalCoupledFunctionObject::on()
|
|
{
|
|
enabled_ = true;
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::off()
|
|
{
|
|
enabled_ = false;
|
|
}
|
|
|
|
|
|
bool Foam::externalCoupledFunctionObject::start()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::externalCoupledFunctionObject::execute(const bool forceWrite)
|
|
{
|
|
if
|
|
(
|
|
enabled()
|
|
&& (!initialised_ || time_.timeIndex() % calcFrequency_ == 0)
|
|
)
|
|
{
|
|
// Initialise the coupling
|
|
initialise();
|
|
|
|
// Write data for external source
|
|
writeData();
|
|
|
|
// remove lock file, signalling external source to execute
|
|
removeLockFile();
|
|
|
|
// Wait for response
|
|
wait();
|
|
|
|
// Remove old data files from OpenFOAM
|
|
removeWriteFiles();
|
|
|
|
// Read data passed back from external source
|
|
readData();
|
|
|
|
// create lock file for external source
|
|
createLockFile();
|
|
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
bool Foam::externalCoupledFunctionObject::end()
|
|
{
|
|
if (enabled())
|
|
{
|
|
// Remove old data files
|
|
removeReadFiles();
|
|
removeWriteFiles();
|
|
removeLockFile();
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::externalCoupledFunctionObject::timeSet()
|
|
{
|
|
// Do nothing - only valid on execute
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::externalCoupledFunctionObject::adjustTimeStep()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
|
|
bool Foam::externalCoupledFunctionObject::read(const dictionary& dict)
|
|
{
|
|
dict.readIfPresent("enabled", enabled_);
|
|
|
|
if (!enabled_)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
dict.lookup("commsDir") >> commsDir_;
|
|
commsDir_.expand();
|
|
|
|
waitInterval_ = dict.lookupOrDefault("waitInterval", 1);
|
|
timeOut_ = dict.lookupOrDefault("timeOut", 100*waitInterval_);
|
|
calcFrequency_ = dict.lookupOrDefault("calcFrequency", 1);
|
|
initByExternal_ = readBool(dict.lookup("initByExternal"));
|
|
log_ = dict.lookupOrDefault("log", false);
|
|
|
|
|
|
// Get names of all fvMeshes (and derived types)
|
|
wordList allRegionNames(time_.lookupClass<fvMesh>().sortedToc());
|
|
|
|
|
|
|
|
const dictionary& allRegionsDict = dict.subDict("regions");
|
|
|
|
forAllConstIter(dictionary, allRegionsDict, iter)
|
|
{
|
|
if (!iter().isDict())
|
|
{
|
|
FatalIOErrorIn
|
|
(
|
|
"void Foam::externalCoupledFunctionObject::read"
|
|
"(const dictionary&)",
|
|
allRegionsDict
|
|
)
|
|
<< "Regions must be specified in dictionary format"
|
|
<< exit(FatalIOError);
|
|
}
|
|
|
|
const wordRe regionGroupName(iter().keyword());
|
|
const dictionary& regionDict = iter().dict();
|
|
|
|
labelList regionIDs = findStrings(regionGroupName, allRegionNames);
|
|
|
|
const wordList regionNames(allRegionNames, regionIDs);
|
|
|
|
regionGroupNames_.append(compositeName(regionNames));
|
|
regionGroupRegions_.append(regionNames);
|
|
|
|
|
|
forAllConstIter(dictionary, regionDict, regionIter)
|
|
{
|
|
if (!regionIter().isDict())
|
|
{
|
|
FatalIOErrorIn
|
|
(
|
|
"void Foam::externalCoupledFunctionObject::read"
|
|
"(const dictionary&)",
|
|
regionDict
|
|
)
|
|
<< "Regions must be specified in dictionary format"
|
|
<< exit(FatalIOError);
|
|
}
|
|
const wordRe groupName(regionIter().keyword());
|
|
const dictionary& groupDict = regionIter().dict();
|
|
|
|
label nGroups = groupNames_.size();
|
|
const wordList readFields(groupDict.lookup("readFields"));
|
|
const wordList writeFields(groupDict.lookup("writeFields"));
|
|
|
|
HashTable<labelList>::iterator fnd = regionToGroups_.find
|
|
(
|
|
regionGroupNames_.last()
|
|
);
|
|
if (fnd != regionToGroups_.end())
|
|
{
|
|
fnd().append(nGroups);
|
|
}
|
|
else
|
|
{
|
|
regionToGroups_.insert
|
|
(
|
|
regionGroupNames_.last(),
|
|
labelList(1, nGroups)
|
|
);
|
|
}
|
|
groupNames_.append(groupName);
|
|
groupReadFields_.append(readFields);
|
|
groupWriteFields_.append(writeFields);
|
|
}
|
|
}
|
|
|
|
|
|
// Print a bit
|
|
if (log_)
|
|
{
|
|
Info<< type() << ": Communicating with regions:" << endl;
|
|
forAll(regionGroupNames_, rgI)
|
|
{
|
|
//const wordList& regionNames = regionGroupRegions_[rgI];
|
|
const word& compName = regionGroupNames_[rgI];
|
|
|
|
Info<< "Region: " << compName << endl << incrIndent;
|
|
const labelList& groups = regionToGroups_[compName];
|
|
forAll(groups, i)
|
|
{
|
|
label groupI = groups[i];
|
|
const wordRe& groupName = groupNames_[groupI];
|
|
|
|
Info<< indent << "patchGroup: " << groupName << "\t"
|
|
<< endl
|
|
<< incrIndent
|
|
<< indent << "Reading fields: "
|
|
<< groupReadFields_[groupI]
|
|
<< endl
|
|
<< indent << "Writing fields: "
|
|
<< groupWriteFields_[groupI]
|
|
<< endl
|
|
<< decrIndent;
|
|
}
|
|
Info<< decrIndent;
|
|
}
|
|
Info<< endl;
|
|
}
|
|
|
|
|
|
// Note: we should not have to make directories since the geometry
|
|
// should already be written - but just make sure
|
|
if (Pstream::master())
|
|
{
|
|
forAll(regionGroupNames_, rgI)
|
|
{
|
|
const word& compName = regionGroupNames_[rgI];
|
|
|
|
const labelList& groups = regionToGroups_[compName];
|
|
forAll(groups, i)
|
|
{
|
|
label groupI = groups[i];
|
|
const wordRe& groupName = groupNames_[groupI];
|
|
|
|
fileName dir(groupDir(commsDir_, compName, groupName));
|
|
if (!isDir(dir))
|
|
{
|
|
if (log_)
|
|
{
|
|
Info<< type() << ": creating communications directory "
|
|
<< dir << endl;
|
|
}
|
|
mkDir(dir);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::updateMesh(const mapPolyMesh& mpm)
|
|
{}
|
|
|
|
|
|
void Foam::externalCoupledFunctionObject::movePoints(const polyMesh& mesh)
|
|
{}
|
|
|
|
|
|
// ************************************************************************* //
|