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:

List of all members.

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 ()
Protected Attributes
RealDist *	m_dist
int	m_dt_write
bool	m_is_global
bool	m_is_writing_time

---

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::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

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

ScalarParticleDistributionMaster::~ScalarParticleDistributionMaster

(

)

Destructor, deletes the distribution

---

Member Function Documentation

void ScalarParticleDistributionMaster::collect

(

)

[virtual]

collect data and add into the distribution

Reimplemented from ScalarParticleFieldMaster.

References TML_Comm::broadcast(), and ScalarParticleFieldMaster::collectFull().

Here is the call graph for this function:

bool ScalarParticleDistributionMaster::needSave

(

int

t

)

[virtual]

check if collecting or writing is necessary at current timestep

Parameters:

t	the timestep

Reimplemented from AFieldMaster.

void ScalarParticleDistributionMaster::write

(

)

[virtual]

write data

Reimplemented from AFieldMaster.

---

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

• ScalarParticleDistributionMaster.h
• ScalarParticleDistributionMaster.cpp