songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ENH: make "file" property in functionObjects a relative path (issue #1125)

Browse Source 
- partial solution for issue #1091

  This generates file properties that are case-relative,
  Eg,

      plane0
      {
          p
          {
              file "<case>/postProcessing/plane0/1/p_plane0.vtk";
          }
          U
          {
              file "<case>/postProcessing/plane0/1/U_plane0.vtk";
          }
      }

   This allows the case to be moved elsewhere and still find its files.

   This functionality was previously added for vtkCloud, but now also
   applies to streamLine, sampledSets and sampledSurfaces
This commit is contained in:
Mark Olesen 2018-12-14 18:03:12 +01:00
parent 2617c326d8
commit 2f9c511be5
6 changed files with 72 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/functionObjects/field/streamLine/streamLineBase.C
View File

@ -783,7 +783,11 @@ bool Foam::functionObjects::streamLineBase::writeToFile()
for (const word& fieldName : scalarNames_)
{
dictionary propsDict;
propsDict.add("file", scalarVtkFile);
propsDict.add
(
"file",
scalarVtkFile.relative(time_.globalPath(), true)
);
setProperty(fieldName, propsDict);
}
@ -791,7 +795,11 @@ bool Foam::functionObjects::streamLineBase::writeToFile()
for (const word& fieldName : vectorNames_)
{
dictionary propsDict;
propsDict.add("file", vectorVtkFile);
propsDict.add
(
"file",
vectorVtkFile.relative(time_.globalPath(), true)
);
setProperty(fieldName, propsDict);
}

48
src/functionObjects/graphics/runTimePostProcessing/functionObjectBase.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2016-2018 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -41,26 +41,6 @@ namespace runTimePostPro
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
bool Foam::functionObjects::runTimePostPro::functionObjectBase::removeFile
(
const word& keyword,
const word& subDictName
)
{
dictionary dict;
state_.getObjectDict(functionObjectName_, subDictName, dict);
fileName fName;
if (dict.readIfPresent(keyword, fName))
{
Foam::rm(fName);
return true;
}
return false;
}
Foam::fileName
Foam::functionObjects::runTimePostPro::functionObjectBase::getFileName
(
@ -71,7 +51,25 @@ Foam::functionObjects::runTimePostPro::functionObjectBase::getFileName
dictionary dict;
state_.getObjectDict(functionObjectName_, subDictName, dict);
return dict.lookupOrDefault<fileName>(keyword, fileName::null);
fileName f;
if (dict.readIfPresent<fileName>(keyword, f))
{
f.expand();
}
return f;
}
bool Foam::functionObjects::runTimePostPro::functionObjectBase::removeFile
(
const word& keyword,
const word& subDictName
)
{
// Foam::rm() ignores empty names etc.
return Foam::rm(getFileName(keyword, subDictName));
}
@ -91,12 +89,6 @@ Foam::functionObjects::runTimePostPro::functionObjectBase::functionObjectBase
{}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
Foam::functionObjects::runTimePostPro::functionObjectBase::~functionObjectBase()
{}
// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
bool Foam::functionObjects::runTimePostPro::functionObjectBase::clear()

25
src/functionObjects/graphics/runTimePostProcessing/functionObjectBase.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2016-2018 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -62,17 +62,6 @@ class functionObjectBase
:
public fieldVisualisationBase
{
private:
// Private Member Functions
//- No copy construct
functionObjectBase(const functionObjectBase&) = delete;
//- No copy assignment
void operator=(const functionObjectBase&) = delete;
protected:
// Protected data
@ -100,11 +89,11 @@ protected:
// \verbatim
// T
// {
// file "path/T_object.vtk";
// file "<case>/relpath/T_object.vtk";
// }
// defaultCloud
// {
// file "path/cloud_0001.vtp";
// file "<case>/relpath/cloud_0001.vtp";
// fields (T U);
// }
// \endverbatim
@ -121,6 +110,12 @@ protected:
bool removeFile(const word& keyword, const word& subDictName);
//- No copy construct
functionObjectBase(const functionObjectBase&) = delete;
//- No copy assignment
void operator=(const functionObjectBase&) = delete;
public:
//- Run-time type information
@ -139,7 +134,7 @@ public:
//- Destructor
virtual ~functionObjectBase();
virtual ~functionObjectBase() = default;
// Member Functions

20
src/functionObjects/lagrangian/vtkCloud/vtkCloud.C
View File

@ -318,20 +318,14 @@ bool Foam::functionObjects::vtkCloud::writeCloud
// }
// }
// Shorten file name to be case-local and use "<case>" shortcut
// to make the content relocatable
dictionary propsDict;
// Use case-local filename and "<case>" shortcut for readable output
// and for possibly relocation of files
fileName fName(file.relative(time_.globalPath()));
if (fName.isAbsolute())
{
propsDict.add("file", fName);
}
else
{
propsDict.add("file", "<case>"/fName);
}
propsDict.add
(
"file",
file.relative(time_.globalPath(), true)
);
propsDict.add("fields", written);
setObjectProperty(name(), cloudName, propsDict);

10
src/sampling/sampledSet/sampledSets/sampledSetsTemplates.C
View File

@ -338,10 +338,18 @@ void Foam::sampledSets::sampleAndWrite(fieldGroup<Type>& fields)
Pstream::scatter(sampleFile);
if (sampleFile.size())
{
// Shorten file name to be case-local and use "<case>" shortcut
// to make the content relocatable
forAll(masterFields, fieldi)
{
dictionary propsDict;
propsDict.add("file", sampleFile);
propsDict.add
(
"file",
sampleFile.relative(time_.globalPath(), true)
);
const word& fieldName = masterFields[fieldi].name();
setProperty(fieldName, propsDict);
}

18
src/sampling/sampledSurface/sampledSurfaces/sampledSurfacesTemplates.C
View File

@ -95,8 +95,15 @@ void Foam::sampledSurfaces::writeSurface
Pstream::scatter(sampleFile);
if (sampleFile.size())
{
// Shorten file name to be case-local and use "<case>" shortcut
// to make the content relocatable
dictionary propsDict;
propsDict.add("file", sampleFile);
propsDict.add
(
"file",
sampleFile.relative(time_.globalPath(), true)
);
setProperty(fieldName, propsDict);
}
}
@ -116,8 +123,15 @@ void Foam::sampledSurfaces::writeSurface
s.interpolate()
);
// Case-local filename and "<case>" shortcut for readable output
// and for possibly relocation of files
dictionary propsDict;
propsDict.add("file", fName);
propsDict.add
(
"file",
fName.relative(time_.globalPath(), true)
);
setProperty(fieldName, propsDict);
}
}