AFieldMaster Class Reference

Abstract base class for master part of field. More...

#include <FieldMaster.h>

Inheritance diagram for AFieldMaster:

Collaboration diagram for AFieldMaster:

Public Member Functions
	AFieldMaster (TML_Comm *, const string &, const string &, const string &, int, int, int)
virtual	~AFieldMaster ()
virtual bool	needSave (int)
virtual void	collect ()=0
virtual void	write ()

Protected Member Functions
string	makeFilename ()
virtual void	writeAsDX ()
virtual void	writeAsPOV ()
virtual void	writeAsSILO ()
virtual void	writeAsSUM ()
virtual void	writeAsMAX ()
virtual void	writeAsRAW_SERIES ()
virtual void	writeAsRAW2 ()
virtual void	writeAsRAW ()
virtual void	writeAsRawWithID ()
virtual void	writeAsRawWithPosID ()

Protected Attributes
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

Static Private Attributes
static int	s_field_count =0

Detailed Description

Abstract base class for master part of field.

Constructor & Destructor Documentation

AFieldMaster()

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

construct AFieldMaster

Parameters

comm	the TML communicator to be used
fieldname	the name of the field to be saved
filename	the name of the output file
savetype	the output file format. Recognized formats: DX, POV
t0	first timestep to be saved
tend	last timestep to be saved
dt	save every dt timesteps

References m_comm, m_dt, m_field_name, m_file_name, m_id, m_save_count, m_t0, m_tend, m_write_type, s_field_count, WRITE_TYPE_DX, WRITE_TYPE_MAX, WRITE_TYPE_POV, WRITE_TYPE_RAW, WRITE_TYPE_RAW2, WRITE_TYPE_RAW_SERIES, WRITE_TYPE_RAW_WITH_ID, WRITE_TYPE_RAW_WITH_POS_ID, WRITE_TYPE_SILO, and WRITE_TYPE_SUM.

~AFieldMaster()

virtual AFieldMaster::~AFieldMaster ( )

inlinevirtual

Member Function Documentation

collect()

virtual void AFieldMaster::collect ( )

pure virtual

Implemented in VectorWallFieldMaster, VectorTriangleFieldMaster, VectorInteractionFieldMaster, ScalarTriangleFieldMaster, ScalarParticleDistributionMaster, VectorParticleFieldMaster, ScalarParticleFieldMaster, and ScalarInteractionFieldMaster.

makeFilename()

string AFieldMaster::makeFilename ( )

protected

make filename for current save

Returns

the filename

References m_file_name, m_save_count, m_write_type, WRITE_TYPE_DX, WRITE_TYPE_POV, WRITE_TYPE_RAW, WRITE_TYPE_RAW2, WRITE_TYPE_RAW_WITH_ID, WRITE_TYPE_RAW_WITH_POS_ID, and WRITE_TYPE_SILO.

Referenced by ScalarInteractionFieldMaster::writeAsDX(), ScalarParticleFieldMaster::writeAsDX(), VectorParticleFieldMaster::writeAsDX(), VectorInteractionFieldMaster::writeAsDX(), ScalarParticleFieldMaster::writeAsPOV(), ScalarInteractionFieldMaster::writeAsRAW(), ScalarTriangleFieldMaster::writeAsRAW(), VectorTriangleFieldMaster::writeAsRAW(), ScalarInteractionFieldMaster::writeAsRAW2(), VectorParticleFieldMaster::writeAsRAW2(), VectorInteractionFieldMaster::writeAsRAW2(), ScalarInteractionFieldMaster::writeAsRawWithID(), VectorParticleFieldMaster::writeAsRawWithID(), VectorInteractionFieldMaster::writeAsRawWithID(), ScalarInteractionFieldMaster::writeAsRawWithPosID(), ScalarParticleFieldMaster::writeAsRawWithPosID(), and VectorInteractionFieldMaster::writeAsRawWithPosID().

Here is the caller graph for this function:

needSave()

bool AFieldMaster::needSave ( int  t )

virtual

Reimplemented in ScalarParticleDistributionMaster.

References m_dt, m_t0, and m_tend.

write()

void AFieldMaster::write ( )

virtual

call the actual write function, depending on m_write_type

Reimplemented in VectorTriangleFieldMaster, TriggeredVectorParticleFieldMaster, ScalarTriangleFieldMaster, and ScalarParticleDistributionMaster.

References m_write_type, WRITE_TYPE_DX, WRITE_TYPE_MAX, WRITE_TYPE_POV, WRITE_TYPE_RAW, WRITE_TYPE_RAW2, WRITE_TYPE_RAW_SERIES, WRITE_TYPE_RAW_WITH_ID, WRITE_TYPE_RAW_WITH_POS_ID, WRITE_TYPE_SILO, WRITE_TYPE_SUM, writeAsDX(), writeAsMAX(), writeAsPOV(), writeAsRAW(), writeAsRAW2(), writeAsRAW_SERIES(), writeAsRawWithID(), writeAsRawWithPosID(), writeAsSILO(), and writeAsSUM().

Referenced by TriggeredVectorParticleFieldMaster::write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsDX()

virtual void AFieldMaster::writeAsDX ( )

inlineprotectedvirtual

Reimplemented in VectorTriangleFieldMaster, VectorInteractionFieldMaster, ScalarTriangleFieldMaster, VectorParticleFieldMaster, ScalarParticleFieldMaster, and ScalarInteractionFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsMAX()

virtual void AFieldMaster::writeAsMAX ( )

inlineprotectedvirtual

Reimplemented in VectorTriangleFieldMaster, VectorInteractionFieldMaster, ScalarTriangleFieldMaster, VectorParticleFieldMaster, ScalarParticleFieldMaster, and ScalarInteractionFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsPOV()

virtual void AFieldMaster::writeAsPOV ( )

inlineprotectedvirtual

Reimplemented in VectorParticleFieldMaster, and ScalarParticleFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsRAW()

virtual void AFieldMaster::writeAsRAW ( )

inlineprotectedvirtual

Reimplemented in VectorTriangleFieldMaster, ScalarTriangleFieldMaster, and ScalarInteractionFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsRAW2()

virtual void AFieldMaster::writeAsRAW2 ( )

inlineprotectedvirtual

Reimplemented in VectorInteractionFieldMaster, VectorParticleFieldMaster, and ScalarInteractionFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsRAW_SERIES()

virtual void AFieldMaster::writeAsRAW_SERIES ( )

inlineprotectedvirtual

Reimplemented in VectorWallFieldMaster, VectorTriangleFieldMaster, VectorInteractionFieldMaster, ScalarTriangleFieldMaster, VectorParticleFieldMaster, ScalarParticleFieldMaster, and ScalarInteractionFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsRawWithID()

virtual void AFieldMaster::writeAsRawWithID ( )

inlineprotectedvirtual

Reimplemented in VectorInteractionFieldMaster, VectorParticleFieldMaster, and ScalarInteractionFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsRawWithPosID()

virtual void AFieldMaster::writeAsRawWithPosID ( )

inlineprotectedvirtual

Reimplemented in VectorInteractionFieldMaster, ScalarParticleFieldMaster, and ScalarInteractionFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsSILO()

virtual void AFieldMaster::writeAsSILO ( )

inlineprotectedvirtual

Reimplemented in VectorWallFieldMaster, VectorParticleFieldMaster, and ScalarParticleFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeAsSUM()

virtual void AFieldMaster::writeAsSUM ( )

inlineprotectedvirtual

Reimplemented in VectorTriangleFieldMaster, VectorInteractionFieldMaster, ScalarTriangleFieldMaster, VectorParticleFieldMaster, ScalarParticleFieldMaster, and ScalarInteractionFieldMaster.

References console, and Console::Error().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_comm

TML_Comm* AFieldMaster::m_comm

protected

Referenced by AFieldMaster(), ScalarInteractionFieldMaster::collect(), ScalarParticleFieldMaster::collect(), VectorParticleFieldMaster::collect(), ScalarParticleDistributionMaster::collect(), ScalarTriangleFieldMaster::collect(), VectorInteractionFieldMaster::collect(), VectorTriangleFieldMaster::collect(), VectorWallFieldMaster::collect(), ScalarInteractionFieldMaster::collectFull(), ScalarParticleFieldMaster::collectFull(), ScalarTriangleFieldMaster::collectFull(), VectorInteractionFieldMaster::collectFull(), VectorTriangleFieldMaster::collectFull(), ScalarInteractionFieldMaster::collectFull2(), VectorInteractionFieldMaster::collectFull2(), ScalarInteractionFieldMaster::collectFullWithID(), VectorInteractionFieldMaster::collectFullWithID(), ScalarInteractionFieldMaster::collectFullWithPosID(), VectorInteractionFieldMaster::collectFullWithPosID(), ScalarInteractionFieldMaster::collectSum(), ScalarParticleFieldMaster::collectSum(), VectorInteractionFieldMaster::collectSum(), ScalarInteractionFieldMaster::ScalarInteractionFieldMaster(), ScalarParticleFieldMaster::ScalarParticleFieldMaster(), ScalarTriangleFieldMaster::ScalarTriangleFieldMaster(), VectorInteractionFieldMaster::VectorInteractionFieldMaster(), VectorParticleFieldMaster::VectorParticleFieldMaster(), VectorTriangleFieldMaster::VectorTriangleFieldMaster(), and VectorWallFieldMaster::VectorWallFieldMaster().

m_dt

int AFieldMaster::m_dt

protected

Referenced by AFieldMaster(), needSave(), and ScalarParticleDistributionMaster::needSave().

m_field_name

string AFieldMaster::m_field_name

protected

Referenced by AFieldMaster(), ScalarInteractionFieldMaster::writeAsDX(), ScalarParticleFieldMaster::writeAsDX(), VectorParticleFieldMaster::writeAsDX(), VectorInteractionFieldMaster::writeAsDX(), ScalarParticleFieldMaster::writeAsSILO(), VectorParticleFieldMaster::writeAsSILO(), and VectorWallFieldMaster::writeAsSILO().

m_file_name

string AFieldMaster::m_file_name

protected

Referenced by AFieldMaster(), TriggeredVectorParticleFieldMaster::IncrementFilename(), makeFilename(), ScalarParticleDistributionMaster::write(), TriggeredVectorParticleFieldMaster::write(), ScalarInteractionFieldMaster::writeAsMAX(), ScalarParticleFieldMaster::writeAsMAX(), VectorParticleFieldMaster::writeAsMAX(), ScalarParticleFieldMaster::writeAsRAW_SERIES(), VectorParticleFieldMaster::writeAsRAW_SERIES(), VectorWallFieldMaster::writeAsRAW_SERIES(), ScalarInteractionFieldMaster::writeAsSUM(), ScalarParticleFieldMaster::writeAsSUM(), VectorParticleFieldMaster::writeAsSUM(), and VectorInteractionFieldMaster::writeAsSUM().

m_id

int AFieldMaster::m_id

protected

Referenced by AFieldMaster(), ScalarInteractionFieldMaster::collect(), ScalarParticleFieldMaster::collect(), VectorParticleFieldMaster::collect(), ScalarParticleDistributionMaster::collect(), ScalarTriangleFieldMaster::collect(), VectorInteractionFieldMaster::collect(), VectorTriangleFieldMaster::collect(), VectorWallFieldMaster::collect(), ScalarInteractionFieldMaster::ScalarInteractionFieldMaster(), ScalarParticleFieldMaster::ScalarParticleFieldMaster(), ScalarTriangleFieldMaster::ScalarTriangleFieldMaster(), VectorInteractionFieldMaster::VectorInteractionFieldMaster(), VectorParticleFieldMaster::VectorParticleFieldMaster(), VectorTriangleFieldMaster::VectorTriangleFieldMaster(), and VectorWallFieldMaster::VectorWallFieldMaster().

m_save_count

int AFieldMaster::m_save_count

protected

Referenced by AFieldMaster(), and makeFilename().

m_t0

int AFieldMaster::m_t0

protected

Referenced by AFieldMaster(), needSave(), and ScalarParticleDistributionMaster::needSave().

m_tend

int AFieldMaster::m_tend

protected

Referenced by AFieldMaster(), needSave(), and ScalarParticleDistributionMaster::needSave().

m_write_type

int AFieldMaster::m_write_type

protected

Referenced by AFieldMaster(), ScalarInteractionFieldMaster::collect(), ScalarParticleFieldMaster::collect(), ScalarTriangleFieldMaster::collect(), VectorInteractionFieldMaster::collect(), VectorTriangleFieldMaster::collect(), ScalarParticleFieldMaster::collectSum(), VectorInteractionFieldMaster::collectSum(), makeFilename(), write(), ScalarTriangleFieldMaster::write(), and VectorTriangleFieldMaster::write().

s_field_count

int AFieldMaster::s_field_count =0

staticprivate

Referenced by AFieldMaster().

---

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

• Fields/FieldMaster.h
• Fields/FieldMaster.cpp