Abstract base class for surface readers with fields. More...
Public Member Functions | |
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... | |
virtual const meshedSurface & | geometry (const label timeIndex)=0 |
Return a reference to the surface geometry. More... | |
virtual instantList | times () const =0 |
Return a list of the available times. More... | |
virtual wordList | fieldNames (const label timeIndex) const =0 |
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 =0 |
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 =0 |
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 =0 |
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 =0 |
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 =0 |
Return a tensor field at a given time. More... | |
Static Public Member Functions | |
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... | |
Protected Attributes | |
fileName | fileName_ |
File name. More... | |
Abstract base class for surface readers with fields.
Some readers support different input options, these are typically specified as 'readOptions' in the containing dictionary.
readOptions { default { verbose false; } ensight { masterOnly false; } }
Definition at line 67 of file surfaceReader.H.
|
explicit |
Construct from fileName.
Definition at line 49 of file surfaceReader.C.
surfaceReader | ( | const fileName & | fName, |
const dictionary & | options | ||
) |
Construct from fileName and specified options.
Definition at line 58 of file surfaceReader.C.
|
virtualdefault |
Destructor.
TypeName | ( | "surfaceReader" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
surfaceReader | , | ||
fileName | , | ||
(const fileName &fName, const dictionary &options) | , | ||
(fName, options) | |||
) |
|
static |
Same as fileFormats::getFormatOptions.
Definition at line 36 of file surfaceReader.C.
References dict, and Foam::fileFormats::getFormatOptions().
|
static |
Return a reference to the selected surfaceReader.
Definition at line 71 of file surfaceReader.C.
References Foam::exit(), Foam::FatalError, and FatalErrorInLookup.
Referenced by surfaceNoise::initialise().
|
pure virtual |
Return a reference to the surface geometry.
Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.
|
pure virtual |
Return a list of the available times.
Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.
|
pure virtual |
Return a list of the available fields at a given time.
Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.
|
pure virtual |
Return a scalar field at a given time.
Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.
|
pure virtual |
Return a vector field at a given time.
Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.
|
pure virtual |
Return a sphericalTensor field at a given time.
Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.
|
pure virtual |
Return a symmTensor field at a given time.
Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.
|
pure virtual |
Return a tensor field at a given time.
Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.
|
protected |
File name.
Definition at line 74 of file surfaceReader.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.