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

Base class for surface readers. More...

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

Public Member Functions

 TypeName ("surfaceReader")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, surfaceReader, fileName,(const fileName &fName),(fName))
 
 surfaceReader (const fileName &fName)
 Construct from fileName. 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 autoPtr< surfaceReader > New (const word &readType, const fileName &fName)
 Return a reference to the selected surfaceReader. More...
 

Protected Attributes

fileName fileName_
 File name. More...
 

Detailed Description

Base class for surface readers.

Source files

Definition at line 53 of file surfaceReader.H.

Constructor & Destructor Documentation

◆ surfaceReader()

surfaceReader ( const fileName &  fName)

Construct from fileName.

Definition at line 41 of file surfaceReader.C.

◆ ~surfaceReader()

virtual ~surfaceReader ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceReader"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

Foam::autoPtr< Foam::surfaceReader > New ( const word &  readType,
const fileName &  fName 
)
static

Return a reference to the selected surfaceReader.

Definition at line 33 of file surfaceReaderNew.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInLookup.

Referenced by surfaceNoise::initialise().

Here is the call graph for this function:
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.

◆ times()

virtual instantList times ( ) const
pure virtual

Return a list of the available times.

Implemented in ensightSurfaceReader.

◆ fieldNames()

virtual wordList fieldNames ( const label  timeIndex) const
pure virtual

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

Implemented in ensightSurfaceReader.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

Member Data Documentation

◆ fileName_

fileName fileName_
protected

File name.

Definition at line 58 of file surfaceReader.H.

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