ScalarParticleDistributionMaster Class Reference

Class for master part of the distribution/histogram of a
scalar field which is defined on particles. More...

#include <ScalarParticleDistributionMaster.h>

Inheritance diagram for ScalarParticleDistributionMaster:

Collaboration diagram for ScalarParticleDistributionMaster:

Public Member Functions
	ScalarParticleDistributionMaster (TML_Comm *, const string &, const string &, const string &, int, int, int, int, double, double, int)
	ScalarParticleDistributionMaster (TML_Comm *, const string &, const string &, const string &, int, int, int, int, double, double, int, int, int)
	~ScalarParticleDistributionMaster ()
virtual bool	needSave (int)
virtual void	collect ()
virtual void	write ()
Public Member Functions inherited from ScalarParticleFieldMaster
	ScalarParticleFieldMaster (TML_Comm *, const string &, const string &, const string &, int, int, int)
	ScalarParticleFieldMaster (TML_Comm *, const string &, const string &, const string &, int, int, int, int, int)
virtual	~ScalarParticleFieldMaster ()
Public Member Functions inherited from AFieldMaster
	AFieldMaster (TML_Comm *, const string &, const string &, const string &, int, int, int)
virtual	~AFieldMaster ()

Protected Attributes
RealDist *	m_dist
int	m_dt_write
bool	m_is_global
bool	m_is_writing_time
Protected Attributes inherited from ScalarParticleFieldMaster
map< int, double >	m_save_map
map< int, double >	m_rad_map
map< int, Vec3 >	m_pos_map
Protected Attributes inherited from AFieldMaster
TML_Comm *	m_comm
string	m_field_name
string	m_file_name
int	m_t0
int	m_tend
int	m_dt
int	m_id
int	m_save_count
int	m_write_type

Additional Inherited Members
Protected Member Functions inherited from ScalarParticleFieldMaster
virtual void	writeAsDX ()
virtual void	writeAsPOV ()
virtual void	writeAsSILO ()
virtual void	writeAsSUM ()
virtual void	writeAsMAX ()
virtual void	writeAsRAW_SERIES ()
virtual void	writeAsRawWithPosID ()
void	collectFull ()
void	collectSum ()
Protected Member Functions inherited from AFieldMaster
string	makeFilename ()
virtual void	writeAsRAW2 ()
virtual void	writeAsRAW ()
virtual void	writeAsRawWithID ()

Detailed Description

Class for master part of the distribution/histogram of a
scalar field which is defined on particles.

Author

Steffen Abe $Revision$ $Date$

Constructor & Destructor Documentation

ScalarParticleDistributionMaster() [1/2]

ScalarParticleDistributionMaster::ScalarParticleDistributionMaster	(	TML_Comm *	comm,
		const string &	fieldname,
		const string &	filename,
		const string &	savetype,
		int	t0,
		int	tend,
		int	dt_coll,
		int	dt_save,
		double	x0,
		double	xmax,
		int	nx
	)

Constructor without tagging info. Set up the Master and broadcast parameters to the slaves.

Parameters

comm	the communicator
fieldname	the name of the field to be saved
filename	the name of the file to be saved into or the base for the generation of the filenames if the saving format requires multiple files
savetype	the way to save data, currently supported are WINDOW and GLOBAL
t0	the first timestep to be saved
tend	the last timestep to be saved
dt_coll	the intervall between timesteps for collecting data
dt_save	the intervall between timesteps for saving the distribution
x0	minimum value of the field
xmax	maximum value of the field
nx	number of bins in the histogram

References m_dist, m_dt_write, and m_is_global.

ScalarParticleDistributionMaster() [2/2]

ScalarParticleDistributionMaster::ScalarParticleDistributionMaster	(	TML_Comm *	comm,
		const string &	fieldname,
		const string &	filename,
		const string &	savetype,
		int	t0,
		int	tend,
		int	dt_coll,
		int	dt_save,
		double	x0,
		double	xmax,
		int	nx,
		int	tag,
		int	mask
	)

Constructor with tagging info. Set up the Master and broadcast parameters to the slaves.

Parameters

comm	the communicator
fieldname	the name of the field to be saved
filename	the name of the file to be saved into or the base for the generation of the filenames if the saving format requires multiple files
savetype	the way to save data, currently supported are WINDOW and GLOBAL
t0	the first timestep to be saved
tend	the last timestep to be saved
dt_coll	the intervall between timesteps for collecting data
dt_save	the intervall between timesteps for saving the distribution
x0	minimum value of the field
xmax	maximum value of the field
nx	number of bins in the histogram
tag	the tag of the particles to be saved
mask	the mask to be applied to the tag

References m_dist, m_dt_write, and m_is_global.

~ScalarParticleDistributionMaster()

ScalarParticleDistributionMaster::~ScalarParticleDistributionMaster

(

)

Destructor, deletes the distribution

References m_dist.

Member Function Documentation

collect()

void ScalarParticleDistributionMaster::collect ( )

virtual

collect data and add into the distribution

Reimplemented from ScalarParticleFieldMaster.

References RealDist::AddSample(), TML_Comm::broadcast(), ScalarParticleFieldMaster::collectFull(), esys::lsm::bpu::iter(), AFieldMaster::m_comm, m_dist, AFieldMaster::m_id, ScalarParticleFieldMaster::m_pos_map, ScalarParticleFieldMaster::m_rad_map, and ScalarParticleFieldMaster::m_save_map.

Here is the call graph for this function:

needSave()

bool ScalarParticleDistributionMaster::needSave ( int  t )

virtual

check if collecting or writing is necessary at current timestep

Parameters

t	the timestep

Reimplemented from AFieldMaster.

References AFieldMaster::m_dt, m_dt_write, m_is_writing_time, AFieldMaster::m_t0, and AFieldMaster::m_tend.

write()

void ScalarParticleDistributionMaster::write ( )

virtual

write data

Reimplemented from AFieldMaster.

References RealDist::Clear(), m_dist, AFieldMaster::m_file_name, m_is_global, m_is_writing_time, and RealDist::Write().

Here is the call graph for this function:

Member Data Documentation

m_dist

RealDist* ScalarParticleDistributionMaster::m_dist

protected

Referenced by collect(), ScalarParticleDistributionMaster(), write(), and ~ScalarParticleDistributionMaster().

m_dt_write

int ScalarParticleDistributionMaster::m_dt_write

protected

Referenced by needSave(), and ScalarParticleDistributionMaster().

m_is_global

bool ScalarParticleDistributionMaster::m_is_global

protected

Referenced by ScalarParticleDistributionMaster(), and write().

m_is_writing_time

bool ScalarParticleDistributionMaster::m_is_writing_time

protected

Referenced by needSave(), and write().

---

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

• Fields/ScalarParticleDistributionMaster.h
• Fields/ScalarParticleDistributionMaster.cpp