ESyS-Particle  4.0.1
Public Member Functions | Protected Attributes | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for ScalarParticleDistributionMaster:
Collaboration graph
[legend]

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)
- Public Member Functions inherited from AFieldMaster
 AFieldMaster (TML_Comm *, const string &, const string &, const string &, int, int, int)

Protected Attributes

RealDistm_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, Vec3m_pos_map
- Protected Attributes inherited from AFieldMaster
TML_Commm_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 ()
void collectFull ()
void collectSum ()

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
commthe communicator
fieldnamethe name of the field to be saved
filenamethe name of the file to be saved into or the base for the generation of the filenames if the saving format requires multiple files
savetypethe way to save data, currently supported are WINDOW and GLOBAL
t0the first timestep to be saved
tendthe last timestep to be saved
dt_collthe intervall between timesteps for collecting data
dt_savethe intervall between timesteps for saving the distribution
x0minimum value of the field
xmaxmaximum value of the field
nxnumber 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
commthe communicator
fieldnamethe name of the field to be saved
filenamethe name of the file to be saved into or the base for the generation of the filenames if the saving format requires multiple files
savetypethe way to save data, currently supported are WINDOW and GLOBAL
t0the first timestep to be saved
tendthe last timestep to be saved
dt_collthe intervall between timesteps for collecting data
dt_savethe intervall between timesteps for saving the distribution
x0minimum value of the field
xmaxmaximum value of the field
nxnumber of bins in the histogram
tagthe tag of the particles to be saved
maskthe 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
tthe timestep

Reimplemented from AFieldMaster.

void ScalarParticleDistributionMaster::write ( )
virtual

write data

Reimplemented from AFieldMaster.


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