ESyS-Particle  4.0.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
ScalarInteractionFieldMaster Class Reference

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

#include <InteractionFieldMaster.h>

Inheritance diagram for ScalarInteractionFieldMaster:
Inheritance graph
[legend]
Collaboration diagram for ScalarInteractionFieldMaster:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::pair
< esys::lsm::quintuple< Vec3,
double, Vec3, double, Vec3 >
, double > 
IVecData2
typedef std::pair
< esys::lsm::triplet< int, int,
Vec3 >, double > 
DataWithID
typedef std::pair
< esys::lsm::quintuple< int,
int, Vec3, Vec3, Vec3 >
, double > 
DataWithPosID

Public Member Functions

 ScalarInteractionFieldMaster (TML_Comm *, const string &, const string &, const string &, const string &, const string &, int, int, int, bool)
 ScalarInteractionFieldMaster (TML_Comm *, const string &, const string &, const string &, const string &, const string &, int, int, int, int, int, bool)
void collect ()

Protected Member Functions

virtual void writeAsDX ()
virtual void writeAsSUM ()
virtual void writeAsMAX ()
virtual void writeAsRAW_SERIES ()
virtual void writeAsRAW2 ()
virtual void writeAsRAW ()
virtual void writeAsRawWithID ()
virtual void writeAsRawWithPosID ()
void collectFull ()
void collectSum ()
void collectMax ()
void collectFull2 ()
void collectFullWithID ()
void collectFullWithPosID ()

Protected Attributes

vector< IVecData2 > m_data2
vector< DataWithID > m_data_with_id
vector< DataWithPosID > m_data_with_pos_id
vector< pair< Vec3, double > > m_data
vector< double > m_sum_vec

Detailed Description

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

Author:
Steffen Abe $Revision$ $Date$

Constructor & Destructor Documentation

ScalarInteractionFieldMaster::ScalarInteractionFieldMaster ( TML_Comm comm,
const string &  fieldname,
const string &  igtype,
const string &  igname,
const string &  filename,
const string &  savetype,
int  t0,
int  tend,
int  dt,
bool  checked 
)

Constructor. Setup master and broadcast parameters to slaves

Parameters:
commthe communicator
fieldnamethe name of the field to be saved
igtypethe type of interaction group for which the field is saved
ignamethe name of the interaction group for which the field is 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
checkedchoose between "full" and "checked" fields

References TML_Comm::broadcast(), and TML_Comm::broadcast_cont().

Here is the call graph for this function:

ScalarInteractionFieldMaster::ScalarInteractionFieldMaster ( TML_Comm comm,
const string &  fieldname,
const string &  igtype,
const string &  igname,
const string &  filename,
const string &  savetype,
int  t0,
int  tend,
int  dt,
int  tag,
int  mask,
bool  checked 
)

Constructor. Setup master and broadcast parameters to slaves

Parameters:
commthe communicator
fieldnamethe name of the field to be saved
igtypethe type of interaction group for which the field is saved
ignamethe name of the interaction group for which the field is 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
checkedchoose between "full" and "checked" fields

References TML_Comm::broadcast(), and TML_Comm::broadcast_cont().

Here is the call graph for this function:


Member Function Documentation

collect full data set

References TML_Comm::broadcast(), and TML_Comm::gather().

Here is the call graph for this function:

collect full data set, both particle positions

References TML_Comm::broadcast(), TML_Comm::gather(), and BasicCon::XDebug().

Here is the call graph for this function:

collect data and <pid1,pid2,pos> info

References TML_Comm::broadcast(), TML_Comm::gather(), and BasicCon::XDebug().

Here is the call graph for this function:

collect data and <pid1,pid2,pos1,pos2,ipos> info

References TML_Comm::broadcast(), TML_Comm::gather(), and BasicCon::XDebug().

Here is the call graph for this function:

collect sum of values only

References TML_Comm::broadcast(), and TML_Comm::gather().

Here is the call graph for this function:

void ScalarInteractionFieldMaster::writeAsDX ( ) [protected, virtual]

write data out as OpenDX compatible file

Todo:
desciption

Reimplemented from AFieldMaster.

References AFieldMaster::makeFilename().

Here is the call graph for this function:

void ScalarInteractionFieldMaster::writeAsMAX ( ) [protected, virtual]

get the maximum of the data and write it out into a single continuous file

Reimplemented from AFieldMaster.

void ScalarInteractionFieldMaster::writeAsRAW ( ) [protected, virtual]

write data as pos1,value pairs

Reimplemented from AFieldMaster.

References AFieldMaster::makeFilename().

Here is the call graph for this function:

void ScalarInteractionFieldMaster::writeAsRAW2 ( ) [protected, virtual]

write data as pos1,pos2,value groups

Reimplemented from AFieldMaster.

References BasicCon::Error(), AFieldMaster::makeFilename(), and BasicCon::XDebug().

Here is the call graph for this function:

void ScalarInteractionFieldMaster::writeAsRAW_SERIES ( ) [protected, virtual]

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

Reimplemented from AFieldMaster.

void ScalarInteractionFieldMaster::writeAsRawWithID ( ) [protected, virtual]

write data as pid1,pid2,ipos,value groups

Reimplemented from AFieldMaster.

References BasicCon::Error(), AFieldMaster::makeFilename(), and BasicCon::XDebug().

Here is the call graph for this function:

write data as pid1,pid2,ipos,value groups

Reimplemented from AFieldMaster.

References BasicCon::Error(), AFieldMaster::makeFilename(), and BasicCon::XDebug().

Here is the call graph for this function:

void ScalarInteractionFieldMaster::writeAsSUM ( ) [protected, virtual]

sum data and write them out into a single continuous file

Reimplemented from AFieldMaster.


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