LibGeoDecomp::SimulationFactory< CELL > Class Template Reference

A convenience class for setting up all objects (e.g. More...

#include <simulationfactory.h>

Inherits LibGeoDecomp::Optimizer::Evaluator.

Collaboration diagram for LibGeoDecomp::SimulationFactory< CELL >:

List of all members.

Public Member Functions
template<typename INITIALIZER >
	SimulationFactory (INITIALIZER initializer)
	~SimulationFactory ()
void	addWriter (const ParallelWriter< CELL > &writer)
void	addWriter (const Writer< CELL > &writer)
Simulator< CELL > *	operator() ()
	Returns a new simulator according to the previously specified parameters.
double	operator() (const SimulationParameters &params)
SimulationParameters &	parameters ()
Private Member Functions
Simulator< CELL > *	buildSimulator (Initializer< CELL > *initializer, const SimulationParameters &params) const
Private Attributes
ClonableInitializer< CELL > *	initializer
SimulationParameters	parameterSet
std::vector< boost::shared_ptr < ParallelWriter< CELL > > >	parallelWriters
std::vector< boost::shared_ptr < Writer< CELL > > >	writers

---

Detailed Description

template<typename CELL>
class LibGeoDecomp::SimulationFactory< CELL >

A convenience class for setting up all objects (e.g.

writers and steerers) necessary for conduction a simulation.

---

Constructor & Destructor Documentation

template<typename CELL >

template<typename INITIALIZER >

LibGeoDecomp::SimulationFactory< CELL >::SimulationFactory

(

INITIALIZER

initializer

)

[inline]

References LibGeoDecomp::SimulationFactory< CELL >::initializer.

template<typename CELL >

LibGeoDecomp::SimulationFactory< CELL >::~SimulationFactory

(

)

[inline]

---

Member Function Documentation

template<typename CELL >

void LibGeoDecomp::SimulationFactory< CELL >::addWriter

(

const ParallelWriter< CELL > &

writer

)

[inline]

template<typename CELL >

void LibGeoDecomp::SimulationFactory< CELL >::addWriter

(

const Writer< CELL > &

writer

)

[inline]

template<typename CELL >

Simulator<CELL>* LibGeoDecomp::SimulationFactory< CELL >::buildSimulator	(	Initializer< CELL > *	initializer,
		const SimulationParameters &	params
	)			const [inline, private]

References LibGeoDecomp::SimulationFactory< CELL >::parameterSet.

template<typename CELL >

double LibGeoDecomp::SimulationFactory< CELL >::operator()

(

const SimulationParameters &

params

)

[inline, virtual]

Implements LibGeoDecomp::Optimizer::Evaluator.

template<typename CELL >

Simulator<CELL>* LibGeoDecomp::SimulationFactory< CELL >::operator()

(

)

[inline]

Returns a new simulator according to the previously specified parameters.

The user is expected to delete the simulator.

References LibGeoDecomp::Writer< CELL_TYPE >::clone(), and LibGeoDecomp::SimulationFactory< CELL >::writers.

template<typename CELL >

SimulationParameters& LibGeoDecomp::SimulationFactory< CELL >::parameters

(

)

[inline]

---

Member Data Documentation

template<typename CELL >

ClonableInitializer<CELL>* LibGeoDecomp::SimulationFactory< CELL >::initializer [private]

Referenced by LibGeoDecomp::SimulationFactory< CELL >::SimulationFactory().

template<typename CELL >

std::vector<boost::shared_ptr<ParallelWriter<CELL> > > LibGeoDecomp::SimulationFactory< CELL >::parallelWriters [private]

template<typename CELL >

SimulationParameters LibGeoDecomp::SimulationFactory< CELL >::parameterSet [private]

Referenced by LibGeoDecomp::SimulationFactory< CELL >::buildSimulator().

template<typename CELL >

std::vector<boost::shared_ptr<Writer<CELL> > > LibGeoDecomp::SimulationFactory< CELL >::writers [private]

Referenced by LibGeoDecomp::SimulationFactory< CELL >::operator()().

---

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

• misc/simulationfactory.h