OPAL (Object Oriented Parallel Accelerator Library): DiscParticle Class Reference

OPAL (Object Oriented Parallel Accelerator Library) 2.2.0

OPAL

#include <DiscParticle.h>

Collaboration diagram for DiscParticle:

Collaboration graph

Classes
struct	RecordInfo

Public Types
enum	DPMode1 { INPUT, OUTPUT, APPEND }

enum	DPMode2 { ALL, ATTRIB }

Public Member Functions
	DiscParticle (const char fname, const char config, int iomode, const char *typestr=0)

	DiscParticle (const char fname, int iomode, const char =0)

	~DiscParticle ()

bool	get_OK () const

unsigned int	get_NumRecords () const

int	get_DataMode (unsigned int record=0) const

int	get_IOMode () const

unsigned int	get_NumLocalParticles (unsigned int record=0) const

unsigned int	get_NumGlobalParticles (unsigned int record=0) const

unsigned int	get_NumAttributes (unsigned int record=0) const

unsigned int	get_ElemByteSize (unsigned int record=0, unsigned int attrib=0) const

const char *	get_TypeString () const

const char *	get_DiscType (unsigned int record=0, unsigned int attrib=0) const

template<class T >
bool	read (IpplParticleBase< T > &pbase, unsigned int record)

template<class T >
bool	read (ParticleAttrib< T > &pattr, unsigned int record)

template<class T >
bool	write (IpplParticleBase< T > &pbase)

template<class T >
bool	write (ParticleAttrib< T > &pattr)

void	printDebug (std::ostream &)

void	printDebug ()

Private Types
typedef long	Offset_t

Private Member Functions
void	initialize (const char base, const char config, const char *typestr, int iomode)

FILE *	open_file (const std::string &fnm, const std::string &mode, bool reporterr=true)

bool	read_meta ()

bool	write_meta ()

void *	read_data (FILE *outputData, unsigned int attrib, unsigned int record, unsigned int fileset)

bool	write_data (FILE outputData, std::vector< Message > &, RecordInfo *)

	DiscParticle (const DiscParticle &)

DiscParticle &	operator= (const DiscParticle &)

Private Attributes
DiscConfig *	Config

bool	ConfigOK

int	IOMode

std::string	BaseFile

std::string	TypeString

std::vector< RecordInfo * >	RecordList

Offset_t	CurrentOffset

Detailed Description

Definition at line 38 of file DiscParticle.h.

Member Typedef Documentation

typedef long DiscParticle::Offset_t

private

Definition at line 663 of file DiscParticle.h.

Member Enumeration Documentation

enum DiscParticle::DPMode1

Enumerator
INPUT
OUTPUT
APPEND

Definition at line 43 of file DiscParticle.h.

enum DiscParticle::DPMode2

Enumerator
ALL
ATTRIB

Definition at line 47 of file DiscParticle.h.

Constructor & Destructor Documentation

DiscParticle::DiscParticle	(	const char *	fname,
		const char *	config,
		int	iomode,
		const char *	typestr = `0`
	)

Definition at line 52 of file DiscParticleFunctions.cpp.

References initialize().

Here is the call graph for this function:

DiscParticle::DiscParticle	(	const char *	fname,
		int	iomode,
		const char *	typestr = `0`
	)

Definition at line 63 of file DiscParticleFunctions.cpp.

References initialize().

Here is the call graph for this function:

DiscParticle::~DiscParticle ( )

Definition at line 110 of file DiscParticleFunctions.cpp.

References Config, and RecordList.

DiscParticle::DiscParticle ( const DiscParticle & )

private

Member Function Documentation

int DiscParticle::get_DataMode ( unsigned int record = 0 ) const

inline

Definition at line 84 of file DiscParticle.h.

References ALL, ATTRIB, and RecordList.

Referenced by get_NumAttributes(), and read().

const char * DiscParticle::get_DiscType	(	unsigned int	record = `0`,
		unsigned int	attrib = `0`
	)		const

Definition at line 126 of file DiscParticleFunctions.cpp.

References get_NumRecords(), and RecordList.

Referenced by printDebug().

Here is the call graph for this function:

unsigned int DiscParticle::get_ElemByteSize	(	unsigned int	record = `0`,
		unsigned int	attrib = `0`
	)		const

inline

Definition at line 108 of file DiscParticle.h.

References RecordList.

Referenced by printDebug(), and read().

int DiscParticle::get_IOMode ( ) const

inline

Definition at line 90 of file DiscParticle.h.

References IOMode.

unsigned int DiscParticle::get_NumAttributes ( unsigned int record = 0 ) const

inline

Definition at line 103 of file DiscParticle.h.

References ALL, get_DataMode(), and RecordList.

Referenced by printDebug(), and read().

Here is the call graph for this function:

unsigned int DiscParticle::get_NumGlobalParticles ( unsigned int record = 0 ) const

inline

Definition at line 98 of file DiscParticle.h.

References RecordList.

Referenced by printDebug().

unsigned int DiscParticle::get_NumLocalParticles ( unsigned int record = 0 ) const

Definition at line 140 of file DiscParticleFunctions.cpp.

References RecordList.

unsigned int DiscParticle::get_NumRecords ( ) const

inline

Definition at line 79 of file DiscParticle.h.

References RecordList.

Referenced by get_DiscType(), printDebug(), read(), and write().

bool DiscParticle::get_OK ( ) const

inline

Definition at line 73 of file DiscParticle.h.

References ConfigOK.

const char* DiscParticle::get_TypeString ( ) const

inline

Definition at line 114 of file DiscParticle.h.

References TypeString.

void DiscParticle::initialize	(	const char *	base,
		const char *	config,
		const char *	typestr,
		int	iomode
	)

private

Definition at line 72 of file DiscParticleFunctions.cpp.

References IpplInfo::abort(), APPEND, BaseFile, Config, ConfigOK, CurrentOffset, INPUT, IOMode, DiscConfig::ok(), OUTPUT, read_meta(), and TypeString.

Referenced by DiscParticle().

Here is the call graph for this function:

FILE * DiscParticle::open_file	(	const std::string &	fnm,
		const std::string &	mode,
		bool	reporterr = `true`
	)

private

Definition at line 151 of file DiscParticleFunctions.cpp.

References endl(), ERRORMSG, and IpplInfo::myNode().

Referenced by read(), write(), and write_meta().

Here is the call graph for this function:

DiscParticle& DiscParticle::operator= ( const DiscParticle & )

private

void DiscParticle::printDebug ( std::ostream & outmsg )

Definition at line 757 of file DiscParticleFunctions.cpp.

References BaseFile, Config, CurrentOffset, endl(), get_DiscType(), get_ElemByteSize(), get_NumAttributes(), get_NumGlobalParticles(), get_NumRecords(), DiscConfig::getNumFiles(), INFORM_ALL_NODES, DiscConfig::printDebug(), and RecordList.

Here is the call graph for this function:

void DiscParticle::printDebug ( )

Definition at line 755 of file DiscParticleFunctions.cpp.

Referenced by read_meta(), and write_meta().

template<class T >

bool DiscParticle::read	(	IpplParticleBase< T > &	pbase,
		unsigned int	record
	)

inline

Definition at line 150 of file DiscParticle.h.

References ALL, Config, ConfigOK, IpplParticleBase< PLayout >::destroy(), DPCTLDBG, ParticleAttribBase::elementSize(), endl(), ERRORMSG, get_DataMode(), get_ElemByteSize(), get_NumAttributes(), get_NumRecords(), IpplParticleBase< PLayout >::getAttribute(), DiscConfig::getConfigFile(), DiscConfig::getFilename(), IpplParticleBase< PLayout >::getLocalNum(), IpplParticleBase< PLayout >::getMessageAndCreate(), DiscConfig::getNumFiles(), DiscConfig::getSMPBox0(), INFORM_ALL_NODES, INPUT, IOMode, IpplInfo::myNode(), IpplParticleBase< PLayout >::numAttributes(), open_file(), PAssert, Message::put(), Message::putmsg(), read_data(), read_meta(), RecordList, Message::setCopy(), Message::setDelete(), and IpplParticleBase< PLayout >::update().

Here is the call graph for this function:

template<class T >

bool DiscParticle::read	(	ParticleAttrib< T > &	pattr,
		unsigned int	record
	)

inline

Definition at line 270 of file DiscParticle.h.

References ATTRIB, Config, ConfigOK, ParticleAttrib< T >::destroy(), DPCTLDBG, ParticleAttribBase::elementSize(), endl(), ERRORMSG, get_DataMode(), get_ElemByteSize(), get_NumRecords(), DiscConfig::getConfigFile(), DiscConfig::getFilename(), ParticleAttrib< T >::getMessage(), DiscConfig::getNumFiles(), DiscConfig::getSMPBox0(), INFORM_ALL_NODES, INPUT, IOMode, IpplInfo::myNode(), open_file(), PAssert, Message::putmsg(), read_data(), read_meta(), RecordList, Message::setCopy(), Message::setDelete(), and ParticleAttrib< T >::size().

Here is the call graph for this function:

void * DiscParticle::read_data	(	FILE *	outputData,
		unsigned int	attrib,
		unsigned int	record,
		unsigned int	fileset
	)

private

Definition at line 705 of file DiscParticleFunctions.cpp.

References DPFDBG, endl(), ERRORMSG, INFORM_ALL_NODES, and RecordList.

Referenced by read().

Here is the call graph for this function:

bool DiscParticle::read_meta ( )

private

Definition at line 253 of file DiscParticleFunctions.cpp.

References DiscMeta::begin(), IpplInfo::Comm, Config, ConfigOK, CurrentOffset, DF_READ_META_TAG, DF_TAG_CYCLE, DPFDBG, endl(), ERRORMSG, DiscConfig::fileSMPs(), Message::get(), DiscConfig::getConfigFile(), DiscConfig::getFilename(), getMessage(), DiscConfig::getNumFiles(), DiscConfig::getNumOtherSMP(), DiscConfig::getNumSMPNodes(), DiscConfig::getOtherSMP(), DiscConfig::getSMPBox0(), DiscConfig::getSMPNode(), INFORM_ALL_NODES, IpplInfo::myNode(), DiscConfig::mySMP(), Hypervolume::n, TagMaker::next_tag(), PAssert, printDebug(), Message::put(), putMessage(), Communicate::receive_block(), RecordList, Communicate::send(), and TypeString.

Referenced by initialize(), read(), and write().

Here is the call graph for this function:

template<class T >

bool DiscParticle::write ( IpplParticleBase< T > & pbase )

inline

Definition at line 371 of file DiscParticle.h.

References APPEND, DiscParticle::RecordInfo::attributes, Communicate::barrier(), DiscParticle::RecordInfo::bytesize, IpplInfo::Comm, COMM_ANY_NODE, Config, ConfigOK, DiscParticle::RecordInfo::disctypes, DPCTLDBG, ParticleAttribBase::elementSize(), endl(), ERRORMSG, FB_TAG_CYCLE, FB_WRITE_TAG, get_NumRecords(), IpplParticleBase< PLayout >::getAttribute(), DiscConfig::getConfigFile(), DiscConfig::getFilename(), IpplParticleBase< PLayout >::getLocalNum(), DiscConfig::getNumOtherSMP(), DiscConfig::getNumSMPNodes(), DiscConfig::getOtherSMP(), DiscConfig::getSMPBox0(), IpplParticleBase< PLayout >::getTotalNum(), DiscParticle::RecordInfo::globalparticles, Options::info, INFORM_ALL_NODES, INPUT, IOMode, DiscParticle::RecordInfo::localparticles, IpplInfo::myNode(), TagMaker::next_tag(), IpplParticleBase< PLayout >::numAttributes(), DiscParticle::RecordInfo::offset, open_file(), PAssert, IpplParticleBase< PLayout >::putMessage(), read_meta(), Communicate::receive_block(), RecordList, Communicate::send(), ParticleAttribBase::typeString(), write_data(), and write_meta().

Here is the call graph for this function:

template<class T >

bool DiscParticle::write ( ParticleAttrib< T > & pattr )

inline

Definition at line 519 of file DiscParticle.h.

References APPEND, DiscParticle::RecordInfo::attributes, Communicate::barrier(), DiscParticle::RecordInfo::bytesize, IpplInfo::Comm, COMM_ANY_NODE, Config, ConfigOK, DiscParticle::RecordInfo::disctypes, DPCTLDBG, ParticleAttribBase::elementSize(), endl(), ERRORMSG, FB_TAG_CYCLE, FB_WRITE_TAG, get_NumRecords(), DiscConfig::getConfigFile(), DiscConfig::getFilename(), DiscConfig::getNumOtherSMP(), DiscConfig::getNumSMPNodes(), DiscConfig::getOtherSMP(), DiscConfig::getSMPBox0(), DiscParticle::RecordInfo::globalparticles, Options::info, INFORM_ALL_NODES, INPUT, IOMode, DiscParticle::RecordInfo::localparticles, IpplInfo::myNode(), TagMaker::next_tag(), DiscParticle::RecordInfo::offset, open_file(), PAssert, Message::put(), ParticleAttrib< T >::putMessage(), read_meta(), Communicate::receive_block(), RecordList, Communicate::send(), ParticleAttrib< T >::size(), ParticleAttribBase::typeString(), write_data(), and write_meta().

Here is the call graph for this function:

bool DiscParticle::write_data	(	FILE *	outputData,
		std::vector< Message * > &	msgvec,
		RecordInfo *	info
	)

private

Definition at line 623 of file DiscParticleFunctions.cpp.

References DiscParticle::RecordInfo::attributes, DiscParticle::RecordInfo::bytesize, CurrentOffset, DPFDBG, endl(), ERRORMSG, INFORM_ALL_NODES, DiscParticle::RecordInfo::localparticles, Hypervolume::n, and DiscParticle::RecordInfo::offset.

Referenced by write().

Here is the call graph for this function:

bool DiscParticle::write_meta ( )

private

Definition at line 182 of file DiscParticleFunctions.cpp.

References Config, ConfigOK, CurrentOffset, DPFDBG, endl(), ERRORMSG, DiscConfig::fileSMPs(), DiscConfig::getFilename(), DiscConfig::getNumFiles(), DiscConfig::getSMPBox0(), INPUT, IOMode, IpplInfo::myNode(), open_file(), printDebug(), RecordList, and TypeString.

Referenced by write().

Here is the call graph for this function:

Member Data Documentation

std::string DiscParticle::BaseFile

private

Definition at line 673 of file DiscParticle.h.

Referenced by initialize(), and printDebug().

DiscConfig* DiscParticle::Config

private

Definition at line 666 of file DiscParticle.h.

Referenced by initialize(), printDebug(), read(), read_meta(), write(), write_meta(), and ~DiscParticle().

bool DiscParticle::ConfigOK

private

Definition at line 667 of file DiscParticle.h.

Referenced by get_OK(), initialize(), read(), read_meta(), write(), and write_meta().

Offset_t DiscParticle::CurrentOffset

private

Definition at line 697 of file DiscParticle.h.

Referenced by initialize(), printDebug(), read_meta(), write_data(), and write_meta().

int DiscParticle::IOMode

private

Definition at line 670 of file DiscParticle.h.

Referenced by get_IOMode(), initialize(), read(), write(), and write_meta().

std::vector<RecordInfo *> DiscParticle::RecordList

private

Definition at line 694 of file DiscParticle.h.

Referenced by get_DataMode(), get_DiscType(), get_ElemByteSize(), get_NumAttributes(), get_NumGlobalParticles(), get_NumLocalParticles(), get_NumRecords(), printDebug(), read(), read_data(), read_meta(), write(), write_meta(), and ~DiscParticle().

std::string DiscParticle::TypeString

private

Definition at line 674 of file DiscParticle.h.

Referenced by get_TypeString(), initialize(), read_meta(), and write_meta().

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

ippl/src/Utility/DiscParticle.h
ippl/src/Utility/DiscParticleFunctions.cpp