#include <DataFileIF.H>

Inheritance diagram for DataFileIF:

Public Types
enum	DataType { Invalid = -1, ASCII = 0, Binary, NUMDATATYPES }

Public Member Functions
	DataFileIF (const DataFileIF::DataType &a_dataType, const Real &a_value, const bool &a_inside)

	DataFileIF (const char *const a_filename, const DataFileIF::DataType &a_dataType, const Real &a_value, const bool &a_inside)

	DataFileIF (const DataFileIF::DataType &a_dataType, const RealVect &a_spacing, const RealVect &a_origin, const Real &a_value, const bool &a_inside)

	DataFileIF (const char *const a_filename, const DataFileIF::DataType &a_dataType, const RealVect &a_spacing, const RealVect &a_origin, const Real &a_value, const bool &a_inside)

	DataFileIF (const DataFileIF::DataType &a_dataType, const IntVect &a_num, const RealVect &a_spacing, const RealVect &a_origin, const Real &a_value, const bool &a_inside)

	DataFileIF (const char *const a_filename, const DataFileIF::DataType &a_dataType, const IntVect &a_num, const RealVect &a_spacing, const RealVect &a_origin, const Real &a_value, const bool &a_inside)

	DataFileIF (const DataFileIF &a_inputIF)
	Copy constructor. More...

	DataFileIF (const RefCountedPtr< FArrayBox > a_ascii_data, const RefCountedPtr< BaseFab< unsigned char > > a_binary_data, const Real &a_noDataValue, const IntVect &a_num, const RealVect &a_spacing, const RealVect &a_origin, const Real &a_value, const bool &a_inside)

virtual	~DataFileIF ()
	Destructor. More...

virtual void	GetHeader (IntVect &a_num, RealVect &a_spacing, RealVect &a_origin) const

virtual void	GetParams (Real &a_value, bool &a_inside) const

virtual void	SetParams (const Real &a_value, const bool &a_inside)

virtual void	SetNoDataValue (const Real &a_value)

virtual Real	value (const RealVect &a_point) const

virtual BaseIF *	newImplicitFunction () const

void	GetFullHeader (IntVect &a_num, RealVect &a_spacing, RealVect &a_origin)

Public Member Functions inherited from BaseIF
	BaseIF ()
	Default constructor. More...

virtual	~BaseIF ()
	Default destructor. More...

virtual Real	value (const IndexTM< int, GLOBALDIM > &a_partialDerivative, const IndexTM< Real, GLOBALDIM > &a_point) const

virtual bool	fastIntersection (const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_origin, const Real &a_dx) const

virtual bool	fastIntersection (const RealVect &a_low, const RealVect &a_high) const

virtual GeometryService::InOut	InsideOutside (const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_origin, const Real &a_dx) const

virtual GeometryService::InOut	InsideOutside (const RealVect &a_low, const RealVect &a_high) const

virtual Real	value (const IndexTM< Real, GLOBALDIM > &a_point) const

virtual void	print (ostream &out) const

virtual void	boxLayoutChanged (const DisjointBoxLayout &a_newBoxLayout, const RealVect &a_dx)

Protected Member Functions
void	OpenFile (ifstream &a_file, const char *const a_filename)

void	CloseFile (ifstream &a_file)

void	ReadMinHeader (IntVect &a_num, istream &a_file)

void	ReadFullHeader (IntVect &a_num, RealVect &a_spacing, RealVect &a_origin, istream &a_file)

void	ReadData (Real &a_maxValue, istream &a_file, const DataFileIF::DataType &a_dataType, const IntVect &a_num)

void	MakeCorners (void)

Protected Attributes
IntVect	m_num

RealVect	m_spacing

RealVect	m_origin

Real	m_value

bool	m_inside

RefCountedPtr< FArrayBox >	m_ascii_data

RefCountedPtr< BaseFab< unsigned char > >	m_binary_data

Real	m_noDataValue

IntVectSet	m_corners

Private Member Functions
	DataFileIF ()

void	operator= (const DataFileIF &a_inputIF)

Additional Inherited Members
Static Public Member Functions inherited from BaseIF
static void	corners (const Box &a_region, const RealVect &a_origin, const Real &a_dx, RealVect &a_lo, RealVect &a_hi)

Detailed Description

This implicit function reads data from a file and produces function values from the data read. The data lies on a rectilinear grid where the number of grid points in each direction, the spacing, and the origin are specified (by the user or in the file). Function values within the data region are obtained using trilinear interpolation. Function values outside the data region are the maximum value of the data read.

The data can be read from standard input or a named file. The data can have no header, an ASCII header containing the number of grid points in each direction:

     numX numY [numZ]

or an ASCII header containing the above information followed by the data spacing in each direction and the origin of the data - both in physical coordinates:

     deltaX  deltaY  [deltaZ]
     originX originY [originZ]

Following any header is the data either in ASCII or binary. The data is assumed to vary most rapidly in the x coordinate, then the y coordinate, and, finally, in the z coordinate (for 3D data).

Member Enumeration Documentation

◆ DataType

enum DataFileIF::DataType

Type of data being read

Enumerator
Invalid
ASCII
Binary
NUMDATATYPES

Constructor & Destructor Documentation

◆ DataFileIF() [1/9]

DataFileIF::DataFileIF	(	const DataFileIF::DataType &	a_dataType,
		const Real &	a_value,
		const bool &	a_inside
	)

Constructor specifying the form of the data (a_dataType - ASCII or Binary), a level set value (a_value), and whether inside the domain is where data is less than the level set value (a_inside). Data is read from standard input and a complete ASCII header (see above) is excepted.

◆ DataFileIF() [2/9]

DataFileIF::DataFileIF	(	const char *const	a_filename,
		const DataFileIF::DataType &	a_dataType,
		const Real &	a_value,
		const bool &	a_inside
	)

Constructor specifying filename (a_filename), the form of the data (a_dataType - ASCII or Binary), level set value (a_value), and whether inside the domain is where data is less than the level set value (a_inside). Data is read from the file named and a complete ASCII header (see above) is expected.

◆ DataFileIF() [3/9]

DataFileIF::DataFileIF	(	const DataFileIF::DataType &	a_dataType,
		const RealVect &	a_spacing,
		const RealVect &	a_origin,
		const Real &	a_value,
		const bool &	a_inside
	)

Constructor specifying the form of the data (a_dataType - ASCII or Binary), the spacing (a_spacing), the physical origin (a_origin), a level set value (a_value), and whether inside the domain is where data is less than the level set value (a_inside). Data is read from standard input and an ASCII header (see above) containing the number of grid points in each direction is excepted.

◆ DataFileIF() [4/9]

DataFileIF::DataFileIF	(	const char *const	a_filename,
		const DataFileIF::DataType &	a_dataType,
		const RealVect &	a_spacing,
		const RealVect &	a_origin,
		const Real &	a_value,
		const bool &	a_inside
	)

Constructor specifying filename (a_filename), the form of the data (a_dataType - ASCII or Binary), the spacing (a_spacing), the physical origin (a_origin), a level set value (a_value), and whether inside the domain is where data is less than the level set value (a_inside). Data is read from the file named and an ASCII header (see above) containing the number of grid points in each direction is excepted.

◆ DataFileIF() [5/9]

DataFileIF::DataFileIF	(	const DataFileIF::DataType &	a_dataType,
		const IntVect &	a_num,
		const RealVect &	a_spacing,
		const RealVect &	a_origin,
		const Real &	a_value,
		const bool &	a_inside
	)

Constructor specifying the form of the data (a_dataType - ASCII or Binary), the spacing (a_spacing), the physical origin (a_origin), the number of grid points in each direction (a_num), a level set value (a_value), and whether inside the domain is where data is less than the level set value (a_inside). Data is read from standard input and no ASCII header (see above) is excepted.

◆ DataFileIF() [6/9]

DataFileIF::DataFileIF	(	const char *const	a_filename,
		const DataFileIF::DataType &	a_dataType,
		const IntVect &	a_num,
		const RealVect &	a_spacing,
		const RealVect &	a_origin,
		const Real &	a_value,
		const bool &	a_inside
	)

Constructor specifying filename (a_filename), the form of the data (a_dataType - ASCII or Binary), the spacing (a_spacing), the physical origin (a_origin), the number of grid points in each direction (a_num), a level set value (a_value), and whether inside the domain is where data is less than the level set value (a_inside). Data is read from the file named and no ASCII header (see above) is excepted.

◆ DataFileIF() [7/9]

DataFileIF::DataFileIF ( const DataFileIF & a_inputIF )

Copy constructor.

◆ DataFileIF() [8/9]

DataFileIF::DataFileIF	(	const RefCountedPtr< FArrayBox >	a_ascii_data,
		const RefCountedPtr< BaseFab< unsigned char > >	a_binary_data,
		const Real &	a_noDataValue,
		const IntVect &	a_num,
		const RealVect &	a_spacing,
		const RealVect &	a_origin,
		const Real &	a_value,
		const bool &	a_inside
	)

This is used by the factory (see below) to create a new object. All objects created in this way share a refcounted pointer to their data.

Constructor specifying a refcounted pointer to the data (a_ascii_data or a_binary_data), the no data value (a_noDataValue), the spacing (a_spacing), the physical origin (a_origin), the number of grid points in each direction (a_num), a level set value (a_value), and whether inside the domain is where data is less than the level set value (a_inside).

◆ ~DataFileIF()

virtual DataFileIF::~DataFileIF ( )

virtual

Destructor.

◆ DataFileIF() [9/9]

DataFileIF::DataFileIF ( )

inlineprivate

References MayDay::Abort().

Member Function Documentation

◆ GetHeader()

virtual void DataFileIF::GetHeader	(	IntVect &	a_num,
		RealVect &	a_spacing,
		RealVect &	a_origin
	)		const

virtual

Return the header information

◆ GetParams()

virtual void DataFileIF::GetParams	(	Real &	a_value,
		bool &	a_inside
	)		const

virtual

Return the parameter information

◆ SetParams()

virtual void DataFileIF::SetParams	(	const Real &	a_value,
		const bool &	a_inside
	)

virtual

Set the parameter information

◆ SetNoDataValue()

virtual void DataFileIF::SetNoDataValue ( const Real & a_value )

virtual

value to use when we are outside

◆ value()

virtual Real DataFileIF::value ( const RealVect & a_point ) const

virtual

Return the value of the function at a_point using trilinear interpolation of the data. If a_point is outside the data then return the maximum data value.

Implements BaseIF.

◆ newImplicitFunction()

virtual BaseIF* DataFileIF::newImplicitFunction ( ) const

virtual

Return a newly allocated derived class. The responsibility for deleting the memory is left to the calling function.

Implements BaseIF.

◆ GetFullHeader()

void DataFileIF::GetFullHeader	(	IntVect &	a_num,
		RealVect &	a_spacing,
		RealVect &	a_origin
	)

inline

References CloseFile(), m_num, m_origin, m_spacing, MakeCorners(), OpenFile(), ReadData(), ReadFullHeader(), and ReadMinHeader().

◆ OpenFile()

void DataFileIF::OpenFile	(	ifstream &	a_file,
		const char *const	a_filename
	)

protected

Referenced by GetFullHeader().

◆ CloseFile()

void DataFileIF::CloseFile ( ifstream & a_file )

protected

Referenced by GetFullHeader().

◆ ReadMinHeader()

void DataFileIF::ReadMinHeader	(	IntVect &	a_num,
		istream &	a_file
	)

protected

Referenced by GetFullHeader().

◆ ReadFullHeader()

void DataFileIF::ReadFullHeader	(	IntVect &	a_num,
		RealVect &	a_spacing,
		RealVect &	a_origin,
		istream &	a_file
	)

protected

Referenced by GetFullHeader().

◆ ReadData()

void DataFileIF::ReadData	(	Real &	a_maxValue,
		istream &	a_file,
		const DataFileIF::DataType &	a_dataType,
		const IntVect &	a_num
	)

protected

Referenced by GetFullHeader().

◆ MakeCorners()

void DataFileIF::MakeCorners ( void )

protected

Referenced by GetFullHeader().

◆ operator=()

void DataFileIF::operator= ( const DataFileIF & a_inputIF )

inlineprivate

References MayDay::Abort().

Member Data Documentation

◆ m_num

IntVect DataFileIF::m_num

protected

Referenced by GetFullHeader().

◆ m_spacing

RealVect DataFileIF::m_spacing

protected

Referenced by GetFullHeader().

◆ m_origin

RealVect DataFileIF::m_origin

protected

Referenced by GetFullHeader().

◆ m_value

Real DataFileIF::m_value

protected

◆ m_inside

bool DataFileIF::m_inside

protected

◆ m_ascii_data

RefCountedPtr<FArrayBox> DataFileIF::m_ascii_data

protected

◆ m_binary_data

RefCountedPtr<BaseFab<unsigned char> > DataFileIF::m_binary_data

protected

◆ m_noDataValue

Real DataFileIF::m_noDataValue

protected

◆ m_corners

IntVectSet DataFileIF::m_corners

protected

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

DataFileIF.H

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DataType

Constructor & Destructor Documentation

◆ DataFileIF() [1/9]

◆ DataFileIF() [2/9]

◆ DataFileIF() [3/9]

◆ DataFileIF() [4/9]

◆ DataFileIF() [5/9]

◆ DataFileIF() [6/9]

◆ DataFileIF() [7/9]

◆ DataFileIF() [8/9]

◆ ~DataFileIF()

◆ DataFileIF() [9/9]

Member Function Documentation

◆ GetHeader()

◆ GetParams()

◆ SetParams()

◆ SetNoDataValue()

◆ value()

◆ newImplicitFunction()

◆ GetFullHeader()

◆ OpenFile()

◆ CloseFile()

◆ ReadMinHeader()

◆ ReadFullHeader()

◆ ReadData()

◆ MakeCorners()

◆ operator=()

Member Data Documentation

◆ m_num

◆ m_spacing

◆ m_origin

◆ m_value

◆ m_inside

◆ m_ascii_data

◆ m_binary_data

◆ m_noDataValue

◆ m_corners