ensightCase Class Reference

Supports writing of ensight cases as well as providing common factory methods to open new files. More...

Classes
class	options

Public Member Functions
	ensightCase (const fileName &ensightDir, const word &caseName, const options &opts)
	ensightCase (const fileName &ensightDir, const word &caseName, const IOstream::streamFormat format=IOstream::BINARY)
	~ensightCase ()=default
const ensightCase::options &	option () const
IOstream::streamFormat	format () const
const fileName &	path () const
const word &	mask () const
word	padded (const label i) const
bool	nodeValues () const
bool	separateCloud () const
void	nextTime (const scalar t)
void	nextTime (const instant &t)
void	setTime (const scalar t, const label index)
void	setTime (const instant &t, const label index)
autoPtr< ensightGeoFile >	newGeometry (bool moving=false) const
autoPtr< ensightFile >	newCloud (const word &cloudName) const
template<class Type >
autoPtr< ensightFile >	newData (const word &varName, const bool isPointData=false) const
template<class Type >
autoPtr< ensightFile >	newPointData (const word &varName) const
template<class Type >
autoPtr< ensightFile >	newCloudData (const word &cloudName, const word &varName) const
void	rewind () const
void	write () const
Ostream &	operator() () const
Ostream &	printInfo (Ostream &os) const
template<class Type >
Foam::autoPtr< Foam::ensightFile >	newData (const word &name, const bool isPointData) const
template<class Type >
Foam::autoPtr< Foam::ensightFile >	newPointData (const word &name) const
template<class Type >
Foam::autoPtr< Foam::ensightFile >	newCloudData (const word &cloudName, const word &name) const

Static Public Attributes
static const char *	dataDirName = "data"
static const char *	geometryName = "geometry"

Detailed Description

Supports writing of ensight cases as well as providing common factory methods to open new files.

Source files

• ensightCase.H
• ensightCase.C
• ensightCaseI.H
• ensightCaseOptions.C
• ensightCaseTemplates.C

Definition at line 63 of file ensightCase.H.

Constructor & Destructor Documentation

ensightCase() [1/2]

ensightCase	(	const fileName &	ensightDir,
		const word &	caseName,
		const options &	opts
	)

Definition at line 373 of file ensightCase.C.

ensightCase() [2/2]

ensightCase	(	const fileName &	ensightDir,
		const word &	caseName,
		const IOstream::streamFormat	format = IOstream::BINARY
	)

Definition at line 398 of file ensightCase.C.

~ensightCase()

~ensightCase ( )

default

Member Function Documentation

option()

const Foam::ensightCase::options & option ( ) const

inline

Definition at line 23 of file ensightCaseI.H.

format()

Foam::IOstream::streamFormat format ( ) const

inline

Definition at line 29 of file ensightCaseI.H.

path()

const Foam::fileName & path ( ) const

inline

Definition at line 35 of file ensightCaseI.H.

mask()

const Foam::word & mask ( ) const

inline

Definition at line 41 of file ensightCaseI.H.

padded()

Foam::word padded ( const label  i ) const

inline

Definition at line 47 of file ensightCaseI.H.

nodeValues()

bool nodeValues ( ) const

inline

Definition at line 53 of file ensightCaseI.H.

Referenced by Foam::writeVolField().

Here is the caller graph for this function:

separateCloud()

bool separateCloud ( ) const

inline

Definition at line 59 of file ensightCaseI.H.

nextTime() [1/2]

void nextTime

(

const scalar

t

)

Definition at line 424 of file ensightCase.C.

References setTime().

Here is the call graph for this function:

nextTime() [2/2]

void nextTime

(

const instant &

t

)

Definition at line 431 of file ensightCase.C.

References Instant< T >::value().

Here is the call graph for this function:

setTime() [1/2]

void setTime	(	const scalar	t,
		const label	index
	)

Definition at line 437 of file ensightCase.C.

References UPstream::master(), Foam::mkDir(), fileName::name(), and Foam::nl.

Here is the call graph for this function:

setTime() [2/2]

void setTime	(	const instant &	t,
		const label	index
	)

Definition at line 462 of file ensightCase.C.

References setTime(), and Instant< T >::value().

Here is the call graph for this function:

newGeometry()

Foam::autoPtr< Foam::ensightGeoFile > newGeometry

(

bool

moving = false

)

const

Definition at line 662 of file ensightCase.C.

References format(), UPstream::master(), Foam::mkDir(), autoPtr::New(), Foam::output(), and path().

Here is the call graph for this function:

newCloud()

Foam::autoPtr< Foam::ensightFile > newCloud

(

const word &

cloudName

)

const

Definition at line 696 of file ensightCase.C.

References cloudName(), UPstream::master(), Foam::output(), cloud::prefix, and Ostream::write().

Here is the call graph for this function:

newData() [1/2]

autoPtr<ensightFile> newData	(	const word &	varName,
		const bool	isPointData = false
	)		const

Referenced by Foam::writeAreaField(), Foam::writePointField(), and Foam::writeVolField().

Here is the caller graph for this function:

newPointData() [1/2]

autoPtr<ensightFile> newPointData

(

const word &

varName

)

const

newCloudData() [1/2]

autoPtr<ensightFile> newCloudData	(	const word &	cloudName,
		const word &	varName
	)		const

rewind()

void rewind

(

)

const

Definition at line 720 of file ensightCase.C.

write()

void write

(

)

const

Definition at line 468 of file ensightCase.C.

References cloudName(), Foam::flush(), Foam::max(), Foam::name(), Foam::nl, cloud::prefix, word::printf(), Foam::setw(), HashTable::sortedToc(), and Foam::writeHeader().

Here is the call graph for this function:

operator()()

Foam::Ostream & operator() ( ) const

inline

Definition at line 67 of file ensightCaseI.H.

printInfo()

Foam::Ostream & printInfo

(

Ostream &

os

)

const

Definition at line 729 of file ensightCase.C.

References format(), Foam::nl, and os().

Here is the call graph for this function:

newData() [2/2]

Foam::autoPtr<Foam::ensightFile> newData	(	const word &	name,
		const bool	isPointData
	)		const

Definition at line 29 of file ensightCaseTemplates.C.

References Foam::name(), Foam::output(), and Ostream::write().

Here is the call graph for this function:

newPointData() [2/2]

Foam::autoPtr<Foam::ensightFile> newPointData

(

const word &

name

)

const

Definition at line 70 of file ensightCaseTemplates.C.

References Foam::name().

Here is the call graph for this function:

newCloudData() [2/2]

Foam::autoPtr<Foam::ensightFile> newCloudData	(	const word &	cloudName,
		const word &	name
	)		const

Definition at line 81 of file ensightCaseTemplates.C.

References cloudName(), Foam::name(), Foam::output(), and Ostream::write().

Here is the call graph for this function:

Member Data Documentation

dataDirName

const char * dataDirName = "data"

static

Definition at line 68 of file ensightCase.H.

geometryName

const char * geometryName = "geometry"

static

Definition at line 76 of file ensightCase.H.

Referenced by ensightWriter::writeCollated().

---

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

• src/fileFormats/ensight/file/ensightCase.H
• src/fileFormats/ensight/file/ensightCase.C
• src/fileFormats/ensight/file/ensightCaseI.H
• src/fileFormats/ensight/file/ensightCaseTemplates.C