Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
surfaceReader Class Referenceabstract

Abstract base class for surface readers with fields. More...

Inheritance diagram for surfaceReader:
Inheritance graph
[legend]
Collaboration diagram for surfaceReader:
Collaboration graph
[legend]

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 label nVertexElements () const =0
 The number of 1D vertex/point elements for the last geometry read. Non-zero when the surface reader is used/misused to read vertex/point elements instead of faces (advanced option) 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...
 

Detailed Description

Abstract base class for surface readers with fields.

Some readers support different input options, these are typically specified as 'formatOptions' (or 'readOptions') in the containing dictionary.

readOptions
{
    default
    {
        verbose     false;
    }

    ensight
    {
        masterOnly  false;
        vertexOnly  false;
    }
}
Source files

Definition at line 70 of file surfaceReader.H.

Constructor & Destructor Documentation

◆ surfaceReader() [1/2]

surfaceReader ( const fileName &  fName)
explicit

Construct from fileName.

◆ surfaceReader() [2/2]

surfaceReader ( const fileName &  fName,
const dictionary &  options 
)

Construct from fileName and specified options.

◆ ~surfaceReader()

virtual ~surfaceReader ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceReader"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
surfaceReader  ,
fileName  ,
(const fileName &fName, const dictionary &options)  ,
(fName, options)   
)

◆ formatOptions()

static dictionary formatOptions ( const dictionary &  dict,
const word &  formatName,
const word &  entryName = "formatOptions" 
)
static

Same as fileFormats::getFormatOptions.

◆ New()

static autoPtr<surfaceReader> New ( const word &  readType,
const fileName &  fName,
const dictionary &  options = dictionary() 
)
static

Return a reference to the selected surfaceReader.

Referenced by surfaceNoise::initialise().

Here is the caller graph for this function:

◆ geometry()

virtual const meshedSurface& geometry ( const label  timeIndex)
pure virtual

Return a reference to the surface geometry.

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

◆ nVertexElements()

virtual label nVertexElements ( ) const
pure virtual

The number of 1D vertex/point elements for the last geometry read. Non-zero when the surface reader is used/misused to read vertex/point elements instead of faces (advanced option)

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

◆ times()

virtual instantList times ( ) const
pure virtual

Return a list of the available times.

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

◆ fieldNames()

virtual wordList fieldNames ( const label  timeIndex) const
pure virtual

Return a list of the available fields at a given time.

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

◆ field() [1/5]

virtual tmp<Field<scalar> > field ( const label  timeIndex,
const label  fieldIndex,
const scalar &  refValue = pTraits< scalar >::zero 
) const
pure virtual

Return a scalar field at a given time.

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

◆ field() [2/5]

virtual tmp<Field<vector> > field ( const label  timeIndex,
const label  fieldIndex,
const vector &  refValue = pTraits< vector >::zero 
) const
pure virtual

Return a vector field at a given time.

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

◆ field() [3/5]

virtual tmp<Field<sphericalTensor> > field ( const label  timeIndex,
const label  fieldIndex,
const sphericalTensor &  refValue = pTraits< sphericalTensor >::zero 
) const
pure virtual

Return a sphericalTensor field at a given time.

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

◆ field() [4/5]

virtual tmp<Field<symmTensor> > field ( const label  timeIndex,
const label  fieldIndex,
const symmTensor &  refValue = pTraits< symmTensor >::zero 
) const
pure virtual

Return a symmTensor field at a given time.

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

◆ field() [5/5]

virtual tmp<Field<tensor> > field ( const label  timeIndex,
const label  fieldIndex,
const tensor &  refValue = pTraits< tensor >::zero 
) const
pure virtual

Return a tensor field at a given time.

Implemented in ensightSurfaceReader, and boundaryDataSurfaceReader.

Member Data Documentation

◆ fileName_

fileName fileName_
protected

File name.

Definition at line 77 of file surfaceReader.H.

The documentation for this class was generated from the following file: