Ensight format surface reader. More...
Public Member Functions | |
TypeName ("ensight") | |
Runtime type information. More... | |
ensightSurfaceReader (const fileName &fName, const dictionary &options=dictionary()) | |
Construct from fileName, with reader options. More... | |
virtual | ~ensightSurfaceReader ()=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 > > | readField (const fileName &dataFile, const word &fieldName) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | readField (const label timeIndex, const label fieldIndex) const |
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... | |
Protected Types | |
enum | idTypes : unsigned char { NONE = 0, IGNORE = 1, GIVEN = 2 } |
Handling of node/element id types (off, assign, ignore, given) More... | |
typedef Tuple2< ensightFaces::elemType, label > | faceInfoTuple |
Tuple of face type (tria3, quad4, nsided) and count. More... | |
Protected Member Functions | |
void | skip (const label n, Istream &is) const |
Helper function to skip forward n steps in stream. More... | |
void | readLine (ISstream &is, string &buffer) const |
Helper function to read an ascii line from file. More... | |
void | debugSection (const word &expected, ISstream &is) const |
Read and check a section header. More... | |
Pair< idTypes > | readGeometryHeader (ensightReadFile &is) const |
Read (and discard) geometry file header. More... | |
void | readCase (ISstream &is) |
Read the case file. More... | |
meshedSurface | readGeometry (const fileName &geometryFile) |
Read and return surface geometry. Updates faceTypeInfo_. More... | |
template<class Type > | |
void | readFromLine (const label nSkip, Istream &is, Type &value) const |
Helper function to return Type after skipping n tokens. More... | |
template<class Type > | |
void | readFromLine (const label nSkip, const string &buffer, Type &value) const |
Helper function to return Type after skipping n tokens. More... | |
template<class Type > | |
tmp< Field< Type > > | readField (const fileName &dataFile, const word &fieldName) const |
Helper function to return a field. More... | |
template<class Type > | |
tmp< Field< Type > > | readField (const label timeIndex, const label fieldIndex) const |
Helper function to return a field. More... | |
Static Protected Member Functions | |
static fileName | replaceMask (const fileName &fName, const label timeIndex) |
Replace the '*' mask chars with a 0 padded string. More... | |
Protected Attributes | |
bool | masterOnly_ |
Read on master and broadcast (in parallel) More... | |
IOstreamOption::streamFormat | readFormat_ |
Format flag. More... | |
fileName | baseDir_ |
Base directory. More... | |
fileName | meshFileName_ |
Name of mesh file, including any subdirectory. More... | |
List< word > | fieldNames_ |
Field names. More... | |
List< string > | fieldFileNames_ |
Field file names. More... | |
label | nTimeSteps_ |
Number of time steps. More... | |
label | timeStartIndex_ |
Start time index. More... | |
label | timeIncrement_ |
Time increment. More... | |
instantList | timeValues_ |
Times. More... | |
autoPtr< meshedSurface > | surfPtr_ |
Pointer to the surface. More... | |
List< faceInfoTuple > | faceTypeInfo_ |
List of face-type/count tuples. More... | |
Protected Attributes inherited from surfaceReader | |
fileName | fileName_ |
File name. More... | |
Additional Inherited Members | |
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... | |
Ensight format surface reader.
readOptions { ensight { debug false; masterOnly false; } }
Format options for ensight:
Property | Description | Required | Default |
---|---|---|---|
debug | Add debug flag | no | false |
masterOnly | Read files on master and broadcast values | no | true |
Definition at line 84 of file ensightSurfaceReader.H.
|
protected |
Tuple of face type (tria3, quad4, nsided) and count.
Definition at line 106 of file ensightSurfaceReader.H.
|
protected |
Handling of node/element id types (off, assign, ignore, given)
Enumerator | |
---|---|
NONE | "off", "assign" |
IGNORE | Read but "ignore". |
GIVEN | Use "given" values (not supported) |
Definition at line 95 of file ensightSurfaceReader.H.
|
explicit |
Construct from fileName, with reader options.
Definition at line 334 of file ensightSurfaceReader.C.
References Pstream::broadcasts(), Foam::ensightOutput::debug, dictionary::getOrDefault(), UPstream::master(), UPstream::parRun(), and UPstream::worldComm.
|
virtualdefault |
Destructor.
|
protected |
Helper function to skip forward n steps in stream.
Definition at line 58 of file ensightSurfaceReader.C.
References DebugInfo, IOstream::good(), n, Foam::nl, and WarningInFunction.
Helper function to read an ascii line from file.
Definition at line 81 of file ensightSurfaceReader.C.
References ISstream::getLine(), IOstream::good(), Foam::stringOps::inplaceTrimRight(), and Foam::pos().
Read and check a section header.
Definition at line 100 of file ensightSurfaceReader.C.
References DebugInfo, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::nl.
|
staticprotected |
Replace the '*' mask chars with a 0 padded string.
Definition at line 122 of file ensightSurfaceReader.C.
References Foam::stringOps::count(), ensightCase::padded(), string::replace(), and timeIndex.
|
protected |
Read (and discard) geometry file header.
Definition at line 146 of file ensightSurfaceReader.C.
References string::contains(), DebugInfo, Pair< T >::first(), Foam::nl, ensightReadFile::read(), ensightReadFile::readBinaryHeader(), and Pair< T >::second().
|
protected |
Read the case file.
Definition at line 223 of file ensightSurfaceReader.C.
References DynamicList< T, SizeMin >::append(), string::contains(), Foam::ensightOutput::debug, DebugInfo, DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOstream::good(), Foam::Info, ISstream::name(), Foam::name(), Foam::nl, s, Foam::stringOps::splitSpace(), and WarningInFunction.
|
protected |
Read and return surface geometry. Updates faceTypeInfo_.
Definition at line 387 of file ensightSurfaceReader.C.
References DynamicList< T, SizeMin >::append(), Foam::ensightOutput::debug, DebugInfo, DebugInFunction, ensightFaces::elemNames, Foam::endl(), f(), Pair< T >::first(), IOstreamOption::format(), IOstreamOption::formatNames, IOstream::good(), IFstream::name(), Foam::nl, nPoints, p, points, ensightReadFile::read(), Pair< T >::second(), UList< T >::size(), and WarningInFunction.
|
protected |
Helper function to return Type after skipping n tokens.
Definition at line 28 of file ensightSurfaceReaderTemplates.C.
|
protected |
Helper function to return Type after skipping n tokens.
Definition at line 42 of file ensightSurfaceReaderTemplates.C.
Helper function to return a field.
Helper function to return a field.
TypeName | ( | "ensight" | ) |
Runtime type information.
|
virtual |
Return a reference to the surface geometry.
Implements surfaceReader.
Definition at line 622 of file ensightSurfaceReader.C.
References Pstream::broadcast(), DebugInFunction, Foam::endl(), UPstream::master(), UPstream::parRun(), timeIndex, and UPstream::worldComm.
|
virtual |
Return a list of the available times.
Implements surfaceReader.
Definition at line 651 of file ensightSurfaceReader.C.
|
virtual |
Return a list of the available fields at a given time.
Implements surfaceReader.
Definition at line 658 of file ensightSurfaceReader.C.
|
virtual |
Return a scalar field at a given time.
Implements surfaceReader.
Definition at line 667 of file ensightSurfaceReader.C.
References timeIndex.
|
virtual |
Return a vector field at a given time.
Implements surfaceReader.
Definition at line 678 of file ensightSurfaceReader.C.
References timeIndex.
|
virtual |
Return a sphericalTensor field at a given time.
Implements surfaceReader.
Definition at line 690 of file ensightSurfaceReader.C.
References timeIndex.
|
virtual |
Return a symmTensor field at a given time.
Implements surfaceReader.
Definition at line 701 of file ensightSurfaceReader.C.
References timeIndex.
|
virtual |
Return a tensor field at a given time.
Implements surfaceReader.
Definition at line 712 of file ensightSurfaceReader.C.
References timeIndex.
Foam::tmp<Foam::Field<Type> > readField | ( | const fileName & | dataFile, |
const word & | fieldName | ||
) | const |
Definition at line 56 of file ensightSurfaceReaderTemplates.C.
References string::contains(), DebugInfo, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, field(), IOstream::good(), IOWarningInFunction, IFstream::name(), Foam::New(), Foam::nl, ensightReadFile::read(), Foam::setComponent(), and Foam::Zero.
Foam::tmp<Foam::Field<Type> > readField | ( | const label | timeIndex, |
const label | fieldIndex | ||
) | const |
Definition at line 162 of file ensightSurfaceReaderTemplates.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Foam::nl, Foam::Pout, and timeIndex.
|
protected |
Read on master and broadcast (in parallel)
Definition at line 114 of file ensightSurfaceReader.H.
|
protected |
Format flag.
Definition at line 119 of file ensightSurfaceReader.H.
|
protected |
Base directory.
Definition at line 124 of file ensightSurfaceReader.H.
|
protected |
Name of mesh file, including any subdirectory.
Definition at line 129 of file ensightSurfaceReader.H.
Field names.
Definition at line 134 of file ensightSurfaceReader.H.
Field file names.
Definition at line 139 of file ensightSurfaceReader.H.
|
protected |
Number of time steps.
Definition at line 144 of file ensightSurfaceReader.H.
|
protected |
Start time index.
Definition at line 149 of file ensightSurfaceReader.H.
|
protected |
Time increment.
Definition at line 154 of file ensightSurfaceReader.H.
|
protected |
Times.
Definition at line 159 of file ensightSurfaceReader.H.
|
protected |
Pointer to the surface.
Definition at line 164 of file ensightSurfaceReader.H.
|
protected |
List of face-type/count tuples.
Definition at line 169 of file ensightSurfaceReader.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.