openfoam/applications/utilities/postProcessing/dataConversion/foamToVTK/readFields.H
Mark Olesen 8ee7595a77 ENH: foamToVTK improvements for (-no-internal, -no-boundary)
- skip loading of fields with -no-internal, -no-boundary

- suppress reporting fields with -no-internal, -no-boundary

- cache loaded volume field for reuse with point interpolation.
  Trade off some memory overhead against reading twice.

  NOTE: this issue will not be evident with foamToEnsight since there
  it only handles cell data *or* point data (not both), so a field is
  only ever loaded/processed once.
2023-01-31 12:45:39 +01:00

128 lines
3.4 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2016-2023 OpenCFD Ltd.
-------------------------------------------------------------------------------
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/>.
InClass
Foam::readFields
Description
Helper routines for reading a field or fields, optionally with
a mesh subset (using fvMeshSubsetProxy).
SourceFiles
readFields.C
\*---------------------------------------------------------------------------*/
#ifndef FoamToVTK_readFields_H
#define FoamToVTK_readFields_H
#include "fvMeshSubsetProxy.H"
#include "objectRegistry.H"
#include "IOobjectList.H"
#include "PtrList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
//- Get the field or return nullptr
template<class GeoField>
tmp<GeoField> getField
(
const IOobject* io,
const typename GeoField::Mesh& mesh,
const bool syncPar
);
//- Get the field and subset it, or return nullptr
template<class GeoField>
tmp<GeoField> getField
(
const IOobject* io,
const fvMeshSubsetProxy& proxy,
const bool syncPar,
objectRegistry* cache = nullptr
);
//- Get the named field from the objects, or return nullptr.
template<class GeoField>
tmp<GeoField> getField
(
const typename GeoField::Mesh& mesh,
const IOobjectList& objects,
const word& fieldName,
const bool syncPar
);
//- Return the named field from the optional cache (if found),
//- or get it from the objects and subset it (add to cache).
//- Return nullptr if nothing worked.
template<class GeoField>
tmp<GeoField> getField
(
const fvMeshSubsetProxy& proxy,
const IOobjectList& objects,
const word& fieldName,
const bool syncPar,
objectRegistry* cache = nullptr
);
//- Read the fields, and return as a pointer list
template<class GeoField>
PtrList<const GeoField> readFields
(
const typename GeoField::Mesh& mesh,
const IOobjectList& objects
);
//- Read the fields, optionally subset, and return as a pointer list
template<class GeoField>
PtrList<const GeoField> readFields
(
const fvMeshSubsetProxy& proxy,
const IOobjectList& objects
);
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "readFields.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //