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

#include <InteractionFieldMaster.h>

Inheritance diagram for ScalarInteractionFieldMaster:

Collaboration diagram for ScalarInteractionFieldMaster:

[legend]

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)

virtual	~ScalarInteractionFieldMaster ()

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	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 Member Functions inherited from AFieldMaster
string	makeFilename ()

virtual void	writeAsPOV ()

virtual void	writeAsSILO ()

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

Protected Attributes inherited from AFieldMaster
TML_Comm *	m_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$

Member Typedef Documentation

◆ DataWithID

typedef std::pair<esys::lsm::triplet<int,int,Vec3>, double> ScalarInteractionFieldMaster::DataWithID

◆ DataWithPosID

typedef std::pair<esys::lsm::quintuple<int,int,Vec3,Vec3,Vec3>, double> ScalarInteractionFieldMaster::DataWithPosID

◆ IVecData2

typedef std::pair<esys::lsm::quintuple<Vec3,double,Vec3,double,Vec3>, double> ScalarInteractionFieldMaster::IVecData2

Constructor & Destructor Documentation

◆ ScalarInteractionFieldMaster() [1/2]

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

comm	the communicator
fieldname	the name of the field to be saved
igtype	the type of interaction group for which the field is saved
igname	the name of the interaction group for which the field is 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 DX,SUM
t0	the first timestep to be saved
tend	the last timestep to be saved
dt	the interval between timesteps to be saving
checked	choose between "full" and "checked" fields

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

Here is the call graph for this function:

◆ ScalarInteractionFieldMaster() [2/2]

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

comm	the communicator
fieldname	the name of the field to be saved
igtype	the type of interaction group for which the field is saved
igname	the name of the interaction group for which the field is 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 DX,SUM
t0	the first timestep to be saved
tend	the last timestep to be saved
dt	the interval between timesteps to be saving
tag	the tag of the particles to be saved
mask	the mask to be applied to the tag
checked	choose between "full" and "checked" fields

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

Here is the call graph for this function:

◆ ~ScalarInteractionFieldMaster()

virtual ScalarInteractionFieldMaster::~ScalarInteractionFieldMaster ( )

inlinevirtual

Member Function Documentation

◆ collect()

void ScalarInteractionFieldMaster::collect ( )

virtual

Implements AFieldMaster.

References TML_Comm::broadcast(), collectFull(), collectFull2(), collectFullWithID(), collectFullWithPosID(), collectSum(), AFieldMaster::m_comm, AFieldMaster::m_id, AFieldMaster::m_write_type, WRITE_TYPE_RAW2, WRITE_TYPE_RAW_WITH_ID, WRITE_TYPE_RAW_WITH_POS_ID, and WRITE_TYPE_SUM.

Here is the call graph for this function:

◆ collectFull()

void ScalarInteractionFieldMaster::collectFull ( )

protected

collect full data set

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

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectFull2()

void ScalarInteractionFieldMaster::collectFull2 ( )

protected

collect full data set, both particle positions

References TML_Comm::broadcast(), console, TML_Comm::gather(), esys::lsm::bpu::iter(), AFieldMaster::m_comm, m_data2, and Console::XDebug().

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectFullWithID()

void ScalarInteractionFieldMaster::collectFullWithID ( )

protected

collect data and <pid1,pid2,pos> info

References TML_Comm::broadcast(), COLL_TYPE_FULL_WITH_ID, console, TML_Comm::gather(), esys::lsm::bpu::iter(), AFieldMaster::m_comm, m_data_with_id, and Console::XDebug().

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectFullWithPosID()

void ScalarInteractionFieldMaster::collectFullWithPosID ( )

protected

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

References TML_Comm::broadcast(), COLL_TYPE_FULL_WITH_POS_ID, console, TML_Comm::gather(), esys::lsm::bpu::iter(), AFieldMaster::m_comm, m_data_with_pos_id, and Console::XDebug().

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectMax()

void ScalarInteractionFieldMaster::collectMax ( )

protected

◆ collectSum()

void ScalarInteractionFieldMaster::collectSum ( )

protected

collect sum of values only

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

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAsDX()

void ScalarInteractionFieldMaster::writeAsDX ( )

protectedvirtual

write data out as OpenDX compatible file

Todo:: desciption

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), m_data, AFieldMaster::m_field_name, and AFieldMaster::makeFilename().

Here is the call graph for this function:

◆ writeAsMAX()

void ScalarInteractionFieldMaster::writeAsMAX ( )

protectedvirtual

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

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), AFieldMaster::m_file_name, and m_sum_vec.

Here is the call graph for this function:

◆ writeAsRAW()

void ScalarInteractionFieldMaster::writeAsRAW ( )

protectedvirtual

write data as pos1,value pairs

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), m_data, and AFieldMaster::makeFilename().

Here is the call graph for this function:

◆ writeAsRAW2()

void ScalarInteractionFieldMaster::writeAsRAW2 ( )

protectedvirtual

write data as pos1,pos2,value groups

Reimplemented from AFieldMaster.

References console, Console::Error(), esys::lsm::bpu::iter(), m_data2, AFieldMaster::makeFilename(), and Console::XDebug().

Here is the call graph for this function:

◆ writeAsRAW_SERIES()

void ScalarInteractionFieldMaster::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.

◆ writeAsRawWithID()

void ScalarInteractionFieldMaster::writeAsRawWithID ( )

protectedvirtual

write data as pid1,pid2,ipos,value groups

Reimplemented from AFieldMaster.

References console, Console::Error(), esys::lsm::bpu::iter(), m_data_with_id, AFieldMaster::makeFilename(), and Console::XDebug().

Here is the call graph for this function:

◆ writeAsRawWithPosID()

void ScalarInteractionFieldMaster::writeAsRawWithPosID ( )

protectedvirtual

write data as pid1,pid2,ipos,value groups

Reimplemented from AFieldMaster.

References console, Console::Error(), esys::lsm::bpu::iter(), m_data_with_id, m_data_with_pos_id, AFieldMaster::makeFilename(), and Console::XDebug().

Here is the call graph for this function:

◆ writeAsSUM()

void ScalarInteractionFieldMaster::writeAsSUM ( )

protectedvirtual

sum data and write them out into a single continuous file

Reimplemented from AFieldMaster.

References esys::lsm::bpu::iter(), AFieldMaster::m_file_name, and m_sum_vec.

Here is the call graph for this function:

Member Data Documentation

◆ m_data

vector<pair<Vec3,double> > ScalarInteractionFieldMaster::m_data

protected

Referenced by collectFull(), writeAsDX(), and writeAsRAW().

◆ m_data2

vector<IVecData2> ScalarInteractionFieldMaster::m_data2

protected

Referenced by collectFull2(), and writeAsRAW2().

◆ m_data_with_id

vector<DataWithID> ScalarInteractionFieldMaster::m_data_with_id

protected

Referenced by collectFullWithID(), writeAsRawWithID(), and writeAsRawWithPosID().

◆ m_data_with_pos_id

vector<DataWithPosID> ScalarInteractionFieldMaster::m_data_with_pos_id

protected

Referenced by collectFullWithPosID(), and writeAsRawWithPosID().

◆ m_sum_vec

vector<double> ScalarInteractionFieldMaster::m_sum_vec

protected

Referenced by collectSum(), writeAsMAX(), and writeAsSUM().

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

Fields/InteractionFieldMaster.h
Fields/InteractionFieldMaster.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DataWithID

◆ DataWithPosID

◆ IVecData2

Constructor & Destructor Documentation

◆ ScalarInteractionFieldMaster() [1/2]

◆ ScalarInteractionFieldMaster() [2/2]

◆ ~ScalarInteractionFieldMaster()

Member Function Documentation

◆ collect()

◆ collectFull()

◆ collectFull2()

◆ collectFullWithID()

◆ collectFullWithPosID()

◆ collectMax()

◆ collectSum()

◆ writeAsDX()

◆ writeAsMAX()

◆ writeAsRAW()

◆ writeAsRAW2()

◆ writeAsRAW_SERIES()

◆ writeAsRawWithID()

◆ writeAsRawWithPosID()

◆ writeAsSUM()

Member Data Documentation

◆ m_data

◆ m_data2

◆ m_data_with_id

◆ m_data_with_pos_id

◆ m_sum_vec