A boundaryData format surface reader. However, the "surface" represented by boundaryData is actually only point data! More...
Public Member Functions | |
TypeName ("boundaryData") | |
Runtime type information. More... | |
boundaryDataSurfaceReader (const fileName &fName, const word &pointsName="points") | |
Construct from fileName. More... | |
boundaryDataSurfaceReader (const fileName &fName, const dictionary &options, const word &pointsName="points") | |
Construct from fileName with reader options. More... | |
virtual | ~boundaryDataSurfaceReader ()=default |
Destructor. More... | |
virtual const meshedSurface & | geometry (const label timeIndex) |
Return a reference to the surface geometry. More... | |
virtual instantList | times () const |
Return a list of the available times. More... | |
virtual wordList | fieldNames (const label timeIndex) const |
Return a list of the available fields at a given time. More... | |
virtual tmp< Field< scalar > > | field (const label timeIndex, const label fieldIndex, const scalar &refValue=pTraits< scalar >::zero) const |
Return a scalar field at a given time. More... | |
virtual tmp< Field< vector > > | field (const label timeIndex, const label fieldIndex, const vector &refValue=pTraits< vector >::zero) const |
Return a vector field at a given time. More... | |
virtual tmp< Field< sphericalTensor > > | field (const label timeIndex, const label fieldIndex, const sphericalTensor &refValue=pTraits< sphericalTensor >::zero) const |
Return a sphericalTensor field at a given time. More... | |
virtual tmp< Field< symmTensor > > | field (const label timeIndex, const label fieldIndex, const symmTensor &refValue=pTraits< symmTensor >::zero) const |
Return a symmTensor field at a given time. More... | |
virtual tmp< Field< tensor > > | field (const label timeIndex, const label fieldIndex, const tensor &refValue=pTraits< tensor >::zero) const |
Return a tensor field at a given time. More... | |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | readFieldTemplate (const label timeIndex, const label fieldIndex) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | readField (const Time &runTime, const fileName &baseDir, const instant &timeDir, const word &fieldName, Type &avg) |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | readField (const fileName &baseDir, const instant &timeDir, const word &fieldName, Type &avg) |
Public Member Functions inherited from surfaceReader | |
TypeName ("surfaceReader") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, surfaceReader, fileName,(const fileName &fName, const dictionary &options),(fName, options)) | |
surfaceReader (const fileName &fName) | |
Construct from fileName. More... | |
surfaceReader (const fileName &fName, const dictionary &options) | |
Construct from fileName and specified options. More... | |
virtual | ~surfaceReader ()=default |
Destructor. More... | |
Static Public Member Functions | |
static pointField | readPoints (const Time &runTime, const fileName &baseDir, const word &pointsName="points") |
Read points file. More... | |
static pointField | readPoints (const fileName &baseDir, const word &pointsName="points") |
Read points file. More... | |
template<class Type > | |
static tmp< Field< Type > > | readField (const Time &runTime, const fileName &baseDir, const instant &timeDir, const word &fieldName, Type &avg) |
Read and return given field. More... | |
template<class Type > | |
static tmp< Field< Type > > | readField (const fileName &baseDir, const instant &timeDir, const word &fieldName, Type &avg) |
Read and return given field. More... | |
Static Public Member Functions inherited from surfaceReader | |
static dictionary | formatOptions (const dictionary &dict, const word &formatName, const word &entryName="formatOptions") |
Same as fileFormats::getFormatOptions. More... | |
static autoPtr< surfaceReader > | New (const word &readType, const fileName &fName, const dictionary &options=dictionary()) |
Return a reference to the selected surfaceReader. More... | |
Additional Inherited Members | |
Protected Attributes inherited from surfaceReader | |
fileName | fileName_ |
File name. More... | |
A boundaryData format surface reader. However, the "surface" represented by boundaryData is actually only point data!
Points <case>/constant/region0/"boundaryData"/patchName/points
Values <case>/constant/region0/"boundaryData"/patchName/TIME/field
readOptions { boundaryData { points points; } }
Format options for boundaryData:
Property | Description | Required | Default |
---|---|---|---|
points | Name of the "points" file | no | points |
Definition at line 84 of file boundaryDataSurfaceReader.H.
|
explicit |
Construct from fileName.
Definition at line 141 of file boundaryDataSurfaceReader.C.
boundaryDataSurfaceReader | ( | const fileName & | fName, |
const dictionary & | options, | ||
const word & | pointsName = "points" |
||
) |
Construct from fileName with reader options.
Definition at line 151 of file boundaryDataSurfaceReader.C.
References Foam::ensightOutput::debug, DebugInFunction, Foam::endl(), Foam::Info, and dictionary::readIfPresent().
|
virtualdefault |
Destructor.
TypeName | ( | "boundaryData" | ) |
Runtime type information.
|
static |
Read points file.
Definition at line 44 of file boundaryDataSurfaceReader.C.
References DebugInfo, Foam::endl(), rawIOField< Type >::field(), io(), points, runTime, and fileName::toAbsolute().
|
static |
Read points file.
Definition at line 83 of file boundaryDataSurfaceReader.C.
References Foam::New().
|
static |
Read and return given field.
|
static |
Read and return given field.
|
virtual |
Return a reference to the surface geometry.
Implements surfaceReader.
Definition at line 178 of file boundaryDataSurfaceReader.C.
References DebugInFunction, Foam::endl(), and timeIndex.
|
virtual |
Return a list of the available times.
Implements surfaceReader.
Definition at line 194 of file boundaryDataSurfaceReader.C.
|
virtual |
Return a list of the available fields at a given time.
Implements surfaceReader.
Definition at line 201 of file boundaryDataSurfaceReader.C.
References UList< T >::begin(), List< T >::clear(), UList< T >::end(), f(), Foam::fileHandler, Foam::name(), UList< T >::size(), Foam::sort(), timeIndex, and Foam::transform().
|
virtual |
Return a scalar field at a given time.
Implements surfaceReader.
Definition at line 231 of file boundaryDataSurfaceReader.C.
References timeIndex.
|
virtual |
Return a vector field at a given time.
Implements surfaceReader.
Definition at line 242 of file boundaryDataSurfaceReader.C.
References timeIndex.
|
virtual |
Return a sphericalTensor field at a given time.
Implements surfaceReader.
Definition at line 254 of file boundaryDataSurfaceReader.C.
References timeIndex.
|
virtual |
Return a symmTensor field at a given time.
Implements surfaceReader.
Definition at line 265 of file boundaryDataSurfaceReader.C.
References timeIndex.
|
virtual |
Return a tensor field at a given time.
Implements surfaceReader.
Definition at line 276 of file boundaryDataSurfaceReader.C.
References timeIndex.
Foam::tmp<Foam::Field<Type> > readFieldTemplate | ( | const label | timeIndex, |
const label | fieldIndex | ||
) | const |
Definition at line 121 of file boundaryDataSurfaceReader.C.
References timeIndex.
Foam::tmp<Foam::Field<Type> > readField | ( | const Time & | runTime, |
const fileName & | baseDir, | ||
const instant & | timeDir, | ||
const word & | fieldName, | ||
Type & | avg | ||
) |
Definition at line 31 of file boundaryDataSurfaceReaderTemplates.C.
References rawIOField< Type >::average(), DebugInfo, Foam::endl(), rawIOField< Type >::field(), rawIOField< Type >::hasAverage(), io(), Instant< T >::name(), Foam::New(), runTime, UList< Type >::size(), and fileName::toAbsolute().
Foam::tmp<Foam::Field<Type> > readField | ( | const fileName & | baseDir, |
const instant & | timeDir, | ||
const word & | fieldName, | ||
Type & | avg | ||
) |
Definition at line 75 of file boundaryDataSurfaceReaderTemplates.C.
References Foam::New().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.