surfaceReader Class Reference

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

#include <surfaceReader.H>

Inheritance diagram for surfaceReader:

Collaboration diagram for surfaceReader:

Public Member Functions
	TypeName ("surfaceReader")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, surfaceReader, fileName,(const fileName &fName, const dictionary &options),(fName, options))
	surfaceReader (const fileName &fName)
	Construct from fileName.
	surfaceReader (const fileName &fName, const dictionary &options)
	Construct from fileName and specified options.
virtual	~surfaceReader ()=default
	Destructor.
virtual const meshedSurface &	geometry (const label timeIndex)=0
	Return a reference to the surface geometry.
virtual instantList	times () const =0
	Return a list of the available times.
virtual wordList	fieldNames (const label timeIndex) const =0
	Return a list of the available fields at a given time.
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.
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.
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.
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.
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.

Static Public Member Functions
static dictionary	formatOptions (const dictionary &dict, const word &formatName, const word &entryName="formatOptions")
	Same as fileFormats::getFormatOptions.
static autoPtr< surfaceReader >	New (const word &readType, const fileName &fName, const dictionary &options=dictionary())
	Return a reference to the selected surfaceReader.

Protected Attributes
fileName	fileName_
	File name.

Detailed Description

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;
    }
}

Source files

• surfaceReader.H
• surfaceReader.C

Definition at line 67 of file surfaceReader.H.

Constructor & Destructor Documentation

surfaceReader() [1/2]

surfaceReader ( const fileName & fName )

explicit

Construct from fileName.

Definition at line 48 of file surfaceReader.C.

References fileName_.

Referenced by boundaryDataSurfaceReader::boundaryDataSurfaceReader(), declareRunTimeSelectionTable(), ensightSurfaceReader::ensightSurfaceReader(), and surfaceReader().

Here is the caller graph for this function:

surfaceReader() [2/2]

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

Construct from fileName and specified options.

Definition at line 57 of file surfaceReader.C.

References surfaceReader().

Here is the call graph for this function:

~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)	)

References dict, and surfaceReader().

Here is the call graph for this function:

formatOptions()

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

static

Same as fileFormats::getFormatOptions.

Definition at line 35 of file surfaceReader.C.

References dict, and Foam::fileFormats::getFormatOptions().

Here is the call graph for this function:

New()

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

static

Return a reference to the selected surfaceReader.

Definition at line 70 of file surfaceReader.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 boundaryDataSurfaceReader, and ensightSurfaceReader.

References timeIndex.

times()

virtual instantList times ( ) const

pure virtual

Return a list of the available times.

Implemented in boundaryDataSurfaceReader, and ensightSurfaceReader.

fieldNames()

virtual wordList fieldNames ( const label timeIndex ) const

pure virtual

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

Implemented in boundaryDataSurfaceReader, and ensightSurfaceReader.

References timeIndex.

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 boundaryDataSurfaceReader, and ensightSurfaceReader.

References timeIndex.

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 boundaryDataSurfaceReader, and ensightSurfaceReader.

References timeIndex.

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 boundaryDataSurfaceReader, and ensightSurfaceReader.

References timeIndex.

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 boundaryDataSurfaceReader, and ensightSurfaceReader.

References timeIndex.

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 boundaryDataSurfaceReader, and ensightSurfaceReader.

References timeIndex.

Member Data Documentation

fileName_

fileName fileName_

protected

File name.

Definition at line 74 of file surfaceReader.H.

Referenced by surfaceReader().

---

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

• src/surfMesh/readers/common/surfaceReader.H
• src/surfMesh/readers/common/surfaceReader.C