ESyS-Particle  2.3.2
ScalarParticleFieldMaster Class Reference

Class for master part of a scalar field which is defined on all particles. More...

#include <ParticleFieldMaster.h>

Inheritance diagram for ScalarParticleFieldMaster:
Collaboration diagram for ScalarParticleFieldMaster:

Public Member Functions

 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 ()
virtual void collect ()
- Public Member Functions inherited from AFieldMaster
 AFieldMaster (TML_Comm *, const string &, const string &, const string &, int, int, int)
virtual ~AFieldMaster ()
virtual bool needSave (int)
virtual void write ()

Protected Member Functions

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 ()

Protected Attributes

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

Detailed Description

Class for master part of a scalar field which is defined on all particles.

Author
Steffen Abe $Revision$ $Date$

Constructor & Destructor Documentation

ScalarParticleFieldMaster::ScalarParticleFieldMaster ( TML_Comm comm,
const string &  fieldname,
const string &  filename,
const string &  savetype,
int  t0,
int  tend,
int  dt 
)

Constructor. 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 DX,SUM
t0the first timestep to be saved
tendthe last timestep to be saved
dtthe interval between timesteps to be saving

References TML_Comm::broadcast(), TML_Comm::broadcast_cont(), AFieldMaster::m_comm, and AFieldMaster::m_id.

Here is the call graph for this function:

ScalarParticleFieldMaster::ScalarParticleFieldMaster ( TML_Comm comm,
const string &  fieldname,
const string &  filename,
const string &  savetype,
int  t0,
int  tend,
int  dt,
int  tag,
int  mask 
)

Constructor. 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 DX,SUM
t0the first timestep to be saved
tendthe last timestep to be saved
dtthe interval between timesteps to be saving
tagthe tag of the particles to be saved
maskthe mask to be applied to the tag

References TML_Comm::broadcast(), TML_Comm::broadcast_cont(), AFieldMaster::m_comm, and AFieldMaster::m_id.

Here is the call graph for this function:

virtual ScalarParticleFieldMaster::~ScalarParticleFieldMaster ( )
inlinevirtual

Member Function Documentation

void ScalarParticleFieldMaster::collect ( )
virtual
void ScalarParticleFieldMaster::collectFull ( )
protected

collect the full set of data, i.e. value, and posn,size of particles

References TML_Comm::broadcast(), TML_Comm::gather(), esys::lsm::bpu::iter(), AFieldMaster::m_comm, m_pos_map, m_rad_map, and m_save_map.

Referenced by ScalarParticleDistributionMaster::collect(), and collect().

Here is the call graph for this function:

Here is the caller graph for this function:

void ScalarParticleFieldMaster::collectSum ( )
protected

collect sum of values only

References TML_Comm::broadcast(), TML_Comm::gather(), esys::lsm::bpu::iter(), AFieldMaster::m_comm, m_save_map, and AFieldMaster::m_write_type.

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

void ScalarParticleFieldMaster::writeAsDX ( )
protectedvirtual

write data out as OpenDX compatible file

Todo:
desciption

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), AFieldMaster::m_field_name, m_pos_map, m_rad_map, m_save_map, and AFieldMaster::makeFilename().

Here is the call graph for this function:

void ScalarParticleFieldMaster::writeAsMAX ( )
protectedvirtual

find max datum and write it out into a single continuous file

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), AFieldMaster::m_file_name, m_pos_map, m_rad_map, and m_save_map.

Here is the call graph for this function:

void ScalarParticleFieldMaster::writeAsPOV ( )
protectedvirtual

write data out as Povray(>=3.0) compatible file

Warning
not fully impl.

Reimplemented from AFieldMaster.

References cmax(), cmin(), esys::lsm::bpu::iter(), m_pos_map, m_rad_map, m_save_map, and AFieldMaster::makeFilename().

Here is the call graph for this function:

void ScalarParticleFieldMaster::writeAsRAW_SERIES ( )
protectedvirtual

write data as a raw series of values, one row of values per time step, all timesteps into the same file

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), AFieldMaster::m_file_name, m_pos_map, m_rad_map, and m_save_map.

Here is the call graph for this function:

void ScalarParticleFieldMaster::writeAsRawWithPosID ( )
protectedvirtual

write data as raw id, position, radius, value, one time step per file

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), m_pos_map, m_rad_map, m_save_map, and AFieldMaster::makeFilename().

Here is the call graph for this function:

void ScalarParticleFieldMaster::writeAsSILO ( )
protectedvirtual

write data out as SILO file (if supported)

Reimplemented from AFieldMaster.

References console, Console::Error(), esys::lsm::bpu::iter(), AFieldMaster::m_field_name, m_pos_map, m_rad_map, m_save_map, NULL, openSiloFile(), Vec3::X(), Vec3::Y(), and Vec3::Z().

Here is the call graph for this function:

void ScalarParticleFieldMaster::writeAsSUM ( )
protectedvirtual

sum data and write them out into a single continuous file

Warning
n

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), AFieldMaster::m_file_name, m_pos_map, m_rad_map, and m_save_map.

Here is the call graph for this function:

Member Data Documentation


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