ESyS-Particle  4.0.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VectorInteractionFieldMaster Class Reference

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

#include <VectorInteractionFieldMaster.h>

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

Public Types

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

Public Member Functions

 VectorInteractionFieldMaster (TML_Comm *, const string &, const string &, const string &, const string &, const string &, int, int, int, bool)
virtual void collect ()
- Public Member Functions inherited from AFieldMaster
 AFieldMaster (TML_Comm *, const string &, const string &, const string &, int, int, int)
virtual bool needSave (int)
virtual void write ()

Protected Member Functions

virtual void writeAsDX ()
virtual void writeAsSUM ()
virtual void writeAsMAX ()
virtual void writeAsRAW_SERIES ()
virtual void writeAsRAW2 ()
virtual void writeAsRawWithID ()
virtual void writeAsRawWithPosID ()
void collectFull ()
void collectSum ()
void collectMax ()
void collectFull2 ()
void collectFullWithID ()
void collectFullWithPosID ()
- Protected Member Functions inherited from AFieldMaster
string makeFilename ()
virtual void writeAsPOV ()
virtual void writeAsSILO ()
virtual void writeAsRAW ()

Protected Attributes

vector< IVecData2 > m_data2
vector< DataWithID > m_data_with_id
vector< DataWithPosID > m_data_with_pos_id
vector< pair< Vec3, Vec3 > > m_data
vector< Vec3m_sum_vec
- 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 vector field which is defined on all particles.

Author
Steffen Abe $Revision$ $Date$

Constructor & Destructor Documentation

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

Member Function Documentation

void VectorInteractionFieldMaster::collectFull ( )
protected

collect full data set

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

Here is the call graph for this function:

void VectorInteractionFieldMaster::collectFull2 ( )
protected

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:

void VectorInteractionFieldMaster::collectFullWithID ( )
protected

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:

void VectorInteractionFieldMaster::collectFullWithPosID ( )
protected

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:

void VectorInteractionFieldMaster::collectSum ( )
protected

collect sum of values only

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

Here is the call graph for this function:

void VectorInteractionFieldMaster::writeAsDX ( )
protectedvirtual

write data out as OpenDX compatible file

Todo:
desciption

Reimplemented from AFieldMaster.

References AFieldMaster::makeFilename().

Here is the call graph for this function:

void VectorInteractionFieldMaster::writeAsRAW2 ( )
protectedvirtual

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 VectorInteractionFieldMaster::writeAsRawWithID ( )
protectedvirtual

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 VectorInteractionFieldMaster::writeAsRawWithPosID ( )
protectedvirtual

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 VectorInteractionFieldMaster::writeAsSUM ( )
protectedvirtual

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: