TSOpt::IWaveSampler Class Reference

#include <iwsamp.hh>

List of all members.

Public Member Functions
	IWaveSampler (IWAVE *state, string key, PARARRAY &pars, FILE *stream)
	main constructor: associates sampler with grid structure of file = value for key in pars.
virtual	~IWaveSampler ()
int	getNumAxes () const
axis const &	getAxis (int i) const
ireal	getCellVol () const
ireal	getRecipCellVol () const
int const *	get_gmin () const
int const *	get_gmax () const
void	sample (grid g, IPNT step, IPNT gtype, bool fwd, bool input, IWAVE *state, int ridx, int iwdx, FILE *stream, bool dryrun=false, ostream &drystr=cerr)
	main method - does far too much work in this version

---

Detailed Description

Definition at line 17 of file iwsamp.hh.

---

Constructor & Destructor Documentation

TSOpt::IWaveSampler::IWaveSampler	(	IWAVE *	state,
		string	key,
		PARARRAY &	pars,
		FILE *	stream
	)

main constructor: associates sampler with grid structure of file = value for key in pars.

Does not define sampling - that would require IOTASK defn, happens on call to sample

virtual TSOpt::IWaveSampler::~IWaveSampler

(

)

[virtual]

---

Member Function Documentation

int TSOpt::IWaveSampler::getNumAxes

(

)

const

Definition at line 56 of file iwsamp.hh.

axis const& TSOpt::IWaveSampler::getAxis

(

int

i

)

const

ireal TSOpt::IWaveSampler::getCellVol

(

)

const

ireal TSOpt::IWaveSampler::getRecipCellVol

(

)

const

int const* TSOpt::IWaveSampler::get_gmin

(

)

const

Definition at line 60 of file iwsamp.hh.

int const* TSOpt::IWaveSampler::get_gmax

(

)

const

Definition at line 61 of file iwsamp.hh.

void TSOpt::IWaveSampler::sample	(	grid	g,
		IPNT	step,
		IPNT	gtype,
		bool	fwd,
		bool	input,
		IWAVE *	state,
		int	ridx,
		int	iwdx,
		FILE *	stream,
		bool	dryrun = false,
		ostream &	drystr = cerr
	)

main method - does far too much work in this version

Parameters:

	g	= simulation grid
	step	= simulation step vector step[dim] is time step index
	gtype	= stagger index array - should be data of rarray
	fwd	= fwd/adj flag
	input	= set if input to simulation, else output
	state	= collection of rdoms defining simulation
	ridx	= rarray index within rdom
	iwdx	= rdom index within state
	stream	= verbose output

---

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

• iwsamp.hh

---