FileInput< VectorType, dim > Class Template Reference

Generic base-class for reading data from a file into a grid function. More...

#include <FileInput.h>

Inheritance diagram for FileInput< VectorType, dim >:

List of all members.

Public Types
typedef base::vec_grid_fct_type	vec_grid_fct_type
typedef base::vec_grid_data_type	vec_grid_data_type
typedef GridFunction< DataType, dim >	grid_fct_type
typedef GridData< DataType, dim >	grid_data_type
typedef LevelTransfer < DataType, dim >	leveltransfer_type
typedef GFLevelTransferSpecificFunc < leveltransfer_type, DataType, dim >	leveltransfer_functor_type
Public Member Functions
	FileInput ()
virtual	~FileInput ()
virtual void	register_at (ControlDevice &Ctrl)
virtual void	register_at (ControlDevice &Ctrl, const std::string &prefix)
virtual void	init ()
virtual void	update ()
virtual void	finish ()
virtual void	SetupData (GridHierarchy *gh, const int &ghosts)
virtual void	ReadIn (vec_grid_fct_type &u, grid_fct_type &IOfunc)
virtual void	ReadIn (grid_fct_type &IOfunc, const char *name)
virtual void	ReadIn (grid_fct_type &IOfunc, const char *name, const int &Time, const int &Level)
void	ReadPlain (grid_fct_type &IOfunc, const char *name, const int &Time, const int &Level, const BBox &where=BBox::_empty_bbox)
void	ReadPlain (grid_fct_type &IOfunc, const char *name, const int &Time, const int &Level, const BBox &to, const BBox &from)
virtual void	ReadIn (grid_data_type &IOdata, const char *name, const int &Time, const int &Level)
virtual void	ReadPlain (grid_data_type &IOdata, const char *name, const int &Time, const int &Level)
virtual void	CloseIO ()
void	SetNcnt (const int &cnt)
const int &	Ncnt () const
const int &	InputType () const
const char *	FileName (int d) const
void	SetLevelTransfer (leveltransfer_type *_leveltransfer)
leveltransfer_type &	LevelTransfer_ ()
const leveltransfer_type &	LevelTransfer_ () const
Protected Attributes
int	_Ncnt
int	_InputType
std::string *	CompName
ControlDevice	LocCtrl
ControlDevice	WhereCtrl
ControlDevice	ToCtrl
ControlDevice	FromCtrl
leveltransfer_type *	_LevelTransfer
leveltransfer_functor_type *	_ProlongFunc
leveltransfer_functor_type *	_RestrictFunc
BBox *	_where
BBox *	_to
BBox *	_from

---

Detailed Description

template<class VectorType, int dim>
class FileInput< VectorType, dim >

Generic base-class for reading data from a file into a grid function.

Author:

Ralf Deiterding

Version:

1.0

Date:

Oct-2005

---

Member Typedef Documentation

template<class VectorType, int dim>

typedef GridData<DataType,dim> FileInput< VectorType, dim >::grid_data_type

Reimplemented in F77FileInput< VectorType, dim >, and SchemeFileInput< SchemeType, dim >.

template<class VectorType, int dim>

typedef GridFunction<DataType,dim> FileInput< VectorType, dim >::grid_fct_type

Reimplemented in F77FileInput< VectorType, dim >, and SchemeFileInput< SchemeType, dim >.

template<class VectorType, int dim>

typedef GFLevelTransferSpecificFunc<leveltransfer_type,DataType,dim> FileInput< VectorType, dim >::leveltransfer_functor_type

template<class VectorType, int dim>

typedef LevelTransfer<DataType,dim> FileInput< VectorType, dim >::leveltransfer_type

template<class VectorType, int dim>

typedef base::vec_grid_data_type FileInput< VectorType, dim >::vec_grid_data_type

Reimplemented from AMRBase< VectorType, dim >.

template<class VectorType, int dim>

typedef base::vec_grid_fct_type FileInput< VectorType, dim >::vec_grid_fct_type

Reimplemented from AMRBase< VectorType, dim >.

Reimplemented in F77FileInput< VectorType, dim >, and SchemeFileInput< SchemeType, dim >.

---

Constructor & Destructor Documentation

template<class VectorType, int dim>

FileInput< VectorType, dim >::FileInput

(

)

[inline]

template<class VectorType, int dim>

virtual FileInput< VectorType, dim >::~FileInput

(

)

[inline, virtual]

---

Member Function Documentation

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::CloseIO

(

)

[inline, virtual]

Referenced by FileInput< SchemeType::VectorType, dim >::finish().

template<class VectorType, int dim>

const char* FileInput< VectorType, dim >::FileName

(

int

d

)

const [inline]

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::finish

(

)

[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::init

(

)

[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

template<class VectorType, int dim>

const int& FileInput< VectorType, dim >::InputType

(

)

const [inline]

template<class VectorType, int dim>

const leveltransfer_type& FileInput< VectorType, dim >::LevelTransfer_

(

)

const [inline]

template<class VectorType, int dim>

leveltransfer_type& FileInput< VectorType, dim >::LevelTransfer_

(

)

[inline]

template<class VectorType, int dim>

const int& FileInput< VectorType, dim >::Ncnt

(

)

const [inline]

Referenced by SchemeFileInput< SchemeType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::ReadIn(), and F77FileInput< VectorType, dim >::ReadIn().

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::ReadIn	(	grid_data_type &	IOdata,
		const char *	name,
		const int &	Time,
		const int &	Level
	)			[inline, virtual]

Reimplemented in F77FileInput< VectorType, dim >.

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::ReadIn	(	grid_fct_type &	IOfunc,
		const char *	name,
		const int &	Time,
		const int &	Level
	)			[inline, virtual]

Reimplemented in F77FileInput< VectorType, dim >, and SchemeFileInput< SchemeType, dim >.

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::ReadIn	(	grid_fct_type &	IOfunc,
		const char *	name
	)			[inline, virtual]

Reimplemented in F77FileInput< VectorType, dim >, and SchemeFileInput< SchemeType, dim >.

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::ReadIn	(	vec_grid_fct_type &	u,
		grid_fct_type &	IOfunc
	)			[inline, virtual]

Reimplemented in F77FileInput< VectorType, dim >, and SchemeFileInput< SchemeType, dim >.

Referenced by SchemeFileInput< SchemeType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::ReadIn(), and F77FileInput< VectorType, dim >::ReadIn().

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::ReadPlain	(	grid_data_type &	IOdata,
		const char *	name,
		const int &	Time,
		const int &	Level
	)			[inline, virtual]

template<class VectorType, int dim>

void FileInput< VectorType, dim >::ReadPlain	(	grid_fct_type &	IOfunc,
		const char *	name,
		const int &	Time,
		const int &	Level,
		const BBox &	to,
		const BBox &	from
	)			[inline]

template<class VectorType, int dim>

void FileInput< VectorType, dim >::ReadPlain	(	grid_fct_type &	IOfunc,
		const char *	name,
		const int &	Time,
		const int &	Level,
		const BBox &	where = BBox::_empty_bbox
	)			[inline]

Referenced by FileInput< SchemeType::VectorType, dim >::ReadIn().

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::register_at	(	ControlDevice &	Ctrl,
		const std::string &	prefix
	)			[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::register_at

(

ControlDevice &

Ctrl

)

[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

Referenced by FileInput< SchemeType::VectorType, dim >::register_at().

template<class VectorType, int dim>

void FileInput< VectorType, dim >::SetLevelTransfer

(

leveltransfer_type *

_leveltransfer

)

[inline]

Referenced by F77FileExactSolution< VectorType, dim >::F77FileExactSolution(), and F77FileInitialCondition< VectorType, dim >::F77FileInitialCondition().

template<class VectorType, int dim>

void FileInput< VectorType, dim >::SetNcnt

(

const int &

cnt

)

[inline]

Referenced by FileInput< SchemeType::VectorType, dim >::update().

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::SetupData	(	GridHierarchy *	gh,
		const int &	ghosts
	)			[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

template<class VectorType, int dim>

virtual void FileInput< VectorType, dim >::update

(

)

[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

---

Member Data Documentation

template<class VectorType, int dim>

BBox * FileInput< VectorType, dim >::_from [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::FileInput(), FileInput< SchemeType::VectorType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::register_at(), and FileInput< SchemeType::VectorType, dim >::~FileInput().

template<class VectorType, int dim>

int FileInput< VectorType, dim >::_InputType [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::InputType(), FileInput< SchemeType::VectorType, dim >::register_at(), and FileInput< SchemeType::VectorType, dim >::SetupData().

template<class VectorType, int dim>

leveltransfer_type* FileInput< VectorType, dim >::_LevelTransfer [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::FileInput(), FileInput< SchemeType::VectorType, dim >::finish(), FileInput< SchemeType::VectorType, dim >::init(), FileInput< SchemeType::VectorType, dim >::LevelTransfer_(), FileInput< SchemeType::VectorType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::register_at(), FileInput< SchemeType::VectorType, dim >::SetLevelTransfer(), FileInput< SchemeType::VectorType, dim >::SetupData(), and FileInput< SchemeType::VectorType, dim >::update().

template<class VectorType, int dim>

int FileInput< VectorType, dim >::_Ncnt [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::Ncnt(), and FileInput< SchemeType::VectorType, dim >::SetNcnt().

template<class VectorType, int dim>

leveltransfer_functor_type* FileInput< VectorType, dim >::_ProlongFunc [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::FileInput(), FileInput< SchemeType::VectorType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::SetupData(), and FileInput< SchemeType::VectorType, dim >::~FileInput().

template<class VectorType, int dim>

leveltransfer_functor_type * FileInput< VectorType, dim >::_RestrictFunc [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::FileInput(), FileInput< SchemeType::VectorType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::SetupData(), and FileInput< SchemeType::VectorType, dim >::~FileInput().

template<class VectorType, int dim>

BBox * FileInput< VectorType, dim >::_to [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::FileInput(), FileInput< SchemeType::VectorType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::register_at(), FileInput< SchemeType::VectorType, dim >::SetupData(), and FileInput< SchemeType::VectorType, dim >::~FileInput().

template<class VectorType, int dim>

BBox* FileInput< VectorType, dim >::_where [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::FileInput(), FileInput< SchemeType::VectorType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::register_at(), and FileInput< SchemeType::VectorType, dim >::~FileInput().

template<class VectorType, int dim>

std::string* FileInput< VectorType, dim >::CompName [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::FileInput(), FileInput< SchemeType::VectorType, dim >::FileName(), FileInput< SchemeType::VectorType, dim >::finish(), SchemeFileInput< SchemeType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::ReadIn(), F77FileInput< VectorType, dim >::ReadIn(), FileInput< SchemeType::VectorType, dim >::register_at(), FileInput< SchemeType::VectorType, dim >::update(), and FileInput< SchemeType::VectorType, dim >::~FileInput().

template<class VectorType, int dim>

ControlDevice FileInput< VectorType, dim >::FromCtrl [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::register_at().

template<class VectorType, int dim>

ControlDevice FileInput< VectorType, dim >::LocCtrl [protected]

Reimplemented from AMRBase< VectorType, dim >.

Referenced by FileInput< SchemeType::VectorType, dim >::register_at().

template<class VectorType, int dim>

ControlDevice FileInput< VectorType, dim >::ToCtrl [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::register_at().

template<class VectorType, int dim>

ControlDevice FileInput< VectorType, dim >::WhereCtrl [protected]

Referenced by FileInput< SchemeType::VectorType, dim >::register_at().

---

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

• amroc/amr/FileInput.h