Detailed Description

Definition at line 16 of file State.H.

#include <State.H>

Public Member Functions
	base ()

	base (const base &inBase)

base &	Zero ()

base &	operator+= (const base &inBase)

base &	operator-= (const base &inBase)

base	operator+ (const base &inBase)

base	operator- (const base &inBase)

base &	operator*= (double inScalar)

base	operator* (double inScalar)

base &	operator= (const base &inState)

virtual void	Destroy (const std::string &fieldName)

virtual void	Report (std::ostream &outStream)

virtual void	CopyStateData (const base &inBase)

virtual void	Copy (const base &inBase)

virtual void	Copy (const base &inBase, const std::string &copyStates)

virtual void	Destroy ()

int	Alias (const std::string &sourceField, const std::string &fieldAlias)

int	ConfigureState (ConfigurationType &inConfig, std::ostream &messageStream)
	Configures state data. More...

int	NumStateFieldComponents (int stateFieldIndex)

int	NumStateFields ()

int	NumStateVar ()

std::vector< std::string >	GetStateFieldNames ()

double *	GetStateFieldData (int stateFieldIndex)

double *	GetStateFieldData (const std::string &fieldName)

int	GetStateFieldIndex (const std::string &fieldName)

const std::vector< int > &	StateFieldIndices () const

int	SetStateFields (const std::vector< int > &inFieldIndices)

int	SetStateFields (const std::vector< std::string > &inFieldNames)

int	SetStateFields (const std::string &inFieldNames)

std::string	ReportMeta ()

Public Member Functions inherited from dataset
size_t	NumNodes ()

size_t	NumCells ()

metadataset &	Meta ()

const metadataset &	Meta () const

DataContainerType &	Data ()

const DataContainerType &	Data () const

size_t	NumData () const

size_t	NumMeta () const

int	InitializeFieldHandles ()

int	InitializeFieldIndices ()

int	GetFieldHandle (const std::string &fieldName) const

int	GetFieldIndexByHandle (int fieldHandle) const

void	SetMetaData (const MetaDataSetType &dataDictionary)

virtual void	Prepare ()

virtual void	Copy (const dataset &inData)

virtual void	Copy (const dataset &inData, const std::string &fieldNames)

virtual void	Copy (const dataset &inData, const std::vector< int > &copyFieldIndices)

virtual size_t	ReCreate ()

virtual size_t	Create (size_t number_of_nodes=0, size_t number_of_cells=0)

int	GetDataIndex (const std::string &name) const

int	GetFieldIndex (const std::string &name) const

metadata &	GetFieldMetaData (const std::string &name)

DataBufferType &	GetFieldData (const std::string &name)

DataBufferType &	Field (const std::string &name)

DataBufferType &	Field (int known_field)

const DataBufferType &	Field (int known_field) const

DataBufferType &	GetFieldDataByHandle (int fieldHandle)

const DataBufferType &	GetFieldDataByHandle (int fieldHandle) const

const DataBufferType &	GetFieldData (const std::string &name) const

const DataBufferType &	Field (const std::string &name) const

bool	FieldEmpty (int known_field=0)

void	SetFieldBuffer (const std::string &name, void *buf)

void	SetFieldBuffer (int known_field, void *buf)

template<class BufferDataType >
void	SetFieldBuffer (const std::string &name, std::vector< BufferDataType > &invec)

template<class BufferDataType >
void	SetFieldBuffer (int known_field, std::vector< BufferDataType > &invec)

template<class BufferDataType >
BufferDataType *	GetFieldBuffer (const std::string &fieldName)

template<class BufferDataType >
BufferDataType *	GetFieldBufferByHandle (int fieldHandle)

template<class BufferDataType >
const BufferDataType *	GetFieldBuffer (const std::string &fieldName) const

template<class BufferDataType >
const BufferDataType *	GetFieldBufferByHandle (int fieldHandle)

template<class BufferDataType >
BufferDataType *	GetFieldBuffer (int known_field)

double *	GetRealFieldBuffer (int known_field)

double *	GetRealFieldBufferByHandle (int fieldHandle)

const double *	GetRealFieldBuffer (int known_field) const

const double *	GetRealFieldBufferByHandle (int fieldHandle) const

const metadata &	GetFieldMetaData (const std::string &name) const

const metadata &	GetFieldMetaData (int fieldId) const

const metadata &	GetFieldMetaDataByHandle (int fieldHandle) const

std::ostream &	WriteFieldToStream (std::ostream &OutStream, const std::string &name) const

std::istream &	ReadFieldFromStream (std::istream &InStream, const std::string &name)

template<typename ValueType >
void	AssignFieldValue (const std::string &name, ValueType value)

void	AddField (const std::string &name, char loc, unsigned int ncomp, unsigned int dsize, const std::string &unit)

void	AddField (const std::string &name, metadata &inMeta)

int	RenameField (int known_field, const std::string &newFieldName)

int	RenameField (const std::string &fieldName, const std::string &newFieldName)

int	MakeLink (int known_field, const std::string &newFieldName)

int	Use (const std::string &fieldNames, dataset &inData)

metadataset	Dictionary (const char loc)

Protected Attributes
int	numStateFields

int	numStateVar

std::vector< int >	stateFieldIndices
	total number of components in unsteady state More...

Protected Attributes inherited from dataset
DataContainerType	data

MetaDataSetType	meta

size_t	numNodes

size_t	numCells

std::vector< int >	fieldIndices

std::map< std::string, int >	fieldHandles

Additional Inherited Members
Public Types inherited from dataset
typedef databuffer	DataBufferType

typedef std::vector< DataBufferType >	DataContainerType

typedef field::metadata	MetaDataType

typedef field::metadataset	MetaDataSetType

Inheritance diagram for base:

[legend]

Collaboration diagram for base:

[legend]

Constructor & Destructor Documentation

◆ base() [1/2]

base ( )

inline

Definition at line 23 of file State.H.

◆ base() [2/2]

base ( const base & inBase )

inline

Definition at line 25 of file State.H.

Member Function Documentation

◆ Alias()

int Alias	(	const std::string &	sourceField,
		const std::string &	fieldAlias
	)

inline

Definition at line 250 of file State.H.

References base::ConfigureState(), and dataset::GetFieldIndex().

Here is the call graph for this function:

◆ ConfigureState()

int ConfigureState	(	ConfigurationType &	inConfig,
		std::ostream &	messageStream
	)

Configures state data.

This routine reads the field data configuration out of the inConfig configuration object and populates the plascomSimulationInfo.metaData which stores the metadata for all the field data.

Definition at line 17 of file State.C.

References pcpp::util::ConfigKey(), Parameters::GetValue(), Parameters::GetValueVector(), and numComponents.

Referenced by base::Alias().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Copy() [1/2]

virtual void Copy ( const base & inBase )

inlinevirtual

Definition at line 223 of file State.H.

References dataset::Copy(), base::Destroy(), base::numStateFields, base::numStateVar, and base::stateFieldIndices.

Referenced by base::operator*(), base::operator+(), base::operator-(), and base::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Copy() [2/2]

virtual void Copy	(	const base &	inBase,
		const std::string &	copyStates
	)

inlinevirtual

Definition at line 234 of file State.H.

References dataset::Copy(), and base::Destroy().

Here is the call graph for this function:

◆ CopyStateData()

virtual void CopyStateData ( const base & inBase )

inlinevirtual

Definition at line 208 of file State.H.

References dataset::Copy(), base::Destroy(), base::numStateFields, base::numStateVar, and base::stateFieldIndices.

Referenced by application::RunPlasCom2().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Destroy() [1/2]

virtual void Destroy ( const std::string & fieldName )

inlinevirtual

Reimplemented from dataset.

Definition at line 141 of file State.H.

References dataset::Destroy().

Here is the call graph for this function:

◆ Destroy() [2/2]

virtual void Destroy ( )

inlinevirtual

Reimplemented from dataset.

Definition at line 240 of file State.H.

References dataset::Destroy(), base::numStateFields, base::numStateVar, and base::stateFieldIndices.

Referenced by base::Copy(), and base::CopyStateData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetStateFieldData() [1/2]

double* GetStateFieldData ( int stateFieldIndex )

inline

Definition at line 283 of file State.H.

References dataset::data, and base::stateFieldIndices.

Referenced by TestStateBasic().

Here is the caller graph for this function:

◆ GetStateFieldData() [2/2]

double* GetStateFieldData ( const std::string & fieldName )

inline

Definition at line 289 of file State.H.

References dataset::data, base::GetStateFieldIndex(), and base::stateFieldIndices.

Here is the call graph for this function:

◆ GetStateFieldIndex()

int GetStateFieldIndex ( const std::string & fieldName )

inline

Definition at line 298 of file State.H.

References dataset::meta, base::numStateFields, and base::stateFieldIndices.

Referenced by base::GetStateFieldData().

Here is the caller graph for this function:

◆ GetStateFieldNames()

std::vector<std::string> GetStateFieldNames ( )

inline

Definition at line 274 of file State.H.

References dataset::meta, base::numStateFields, and base::stateFieldIndices.

Referenced by TestStateBasic().

Here is the caller graph for this function:

◆ NumStateFieldComponents()

int NumStateFieldComponents ( int stateFieldIndex )

inline

Definition at line 263 of file State.H.

References dataset::meta, and base::stateFieldIndices.

◆ NumStateFields()

int NumStateFields ( )

inline

Definition at line 270 of file State.H.

References base::numStateFields.

Referenced by TestStateBasic().

Here is the caller graph for this function:

◆ NumStateVar()

int NumStateVar ( )

inline

Definition at line 272 of file State.H.

References base::numStateVar.

Referenced by TestStateBasic().

Here is the caller graph for this function:

◆ operator*()

base operator* ( double inScalar )

inline

Definition at line 125 of file State.H.

References base::Copy().

Here is the call graph for this function:

◆ operator*=()

base& operator*= ( double inScalar )

inline

Definition at line 111 of file State.H.

References databuffer::Data(), dataset::data, databuffer::NItems(), and base::stateFieldIndices.

Here is the call graph for this function:

◆ operator+()

base operator+ ( const base & inBase )

inline

Definition at line 95 of file State.H.

References base::Copy().

Here is the call graph for this function:

◆ operator+=()

base& operator+= ( const base & inBase )

inline

Definition at line 47 of file State.H.

References dataset::data, dataset::meta, databuffer::NItems(), and base::stateFieldIndices.

Here is the call graph for this function:

◆ operator-()

base operator- ( const base & inBase )

inline

Definition at line 103 of file State.H.

References base::Copy().

Here is the call graph for this function:

◆ operator-=()

base& operator-= ( const base & inBase )

inline

Definition at line 67 of file State.H.

References databuffer::Data(), dataset::data, dataset::meta, databuffer::NItems(), and base::stateFieldIndices.

Here is the call graph for this function:

◆ operator=()

base& operator= ( const base & inState )

inline

Definition at line 133 of file State.H.

References base::Copy().

Here is the call graph for this function:

◆ Report()

virtual void Report ( std::ostream & outStream )

inlinevirtual

Definition at line 145 of file State.H.

References dataset::data, dataset::meta, numComponents, dataset::NumData(), numPoints, pcpp::util::ReportBufferStats(), and base::stateFieldIndices.

Referenced by plascom2::util::PC2Compare(), and base::ReportMeta().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReportMeta()

std::string ReportMeta ( )

inline

Definition at line 362 of file State.H.

References dataset::Meta(), and base::Report().

Here is the call graph for this function:

◆ SetStateFields() [1/3]

int SetStateFields ( const std::vector< int > & inFieldIndices )

inline

Definition at line 310 of file State.H.

References dataset::meta, dataset::NumMeta(), base::numStateFields, base::numStateVar, and base::stateFieldIndices.

Referenced by plascom2::util::PC2Compare(), base::SetStateFields(), TestHaloBasic(), TestHaloParallel(), TestHaloPeriodic(), TestHaloThreaded(), TestHDF5GridIO(), TestHDF5PBSGridIO(), TestRK4Advancer(), TestRK4Advancer2(), and TestStateBasic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetStateFields() [2/3]

int SetStateFields ( const std::vector< std::string > & inFieldNames )

inline

Definition at line 329 of file State.H.

References dataset::GetDataIndex(), dataset::meta, dataset::NumMeta(), base::numStateFields, base::numStateVar, and base::stateFieldIndices.

Here is the call graph for this function:

◆ SetStateFields() [3/3]

int SetStateFields ( const std::string & inFieldNames )

inline

Definition at line 350 of file State.H.

References base::SetStateFields().

Here is the call graph for this function:

◆ StateFieldIndices()

const std::vector<int>& StateFieldIndices ( ) const

inline

Definition at line 307 of file State.H.

References base::stateFieldIndices.

Referenced by halo::ConfigureData(), halo::PackSendBuffers(), and TestStateBasic().

Here is the caller graph for this function:

◆ Zero()

base& Zero ( )

inline

Definition at line 33 of file State.H.

References databuffer::Data(), dataset::data, databuffer::NItems(), and base::stateFieldIndices.

Here is the call graph for this function:

Member Data Documentation

◆ numStateFields

int numStateFields

protected

Definition at line 365 of file State.H.

Referenced by base::Copy(), base::CopyStateData(), base::Destroy(), base::GetStateFieldIndex(), base::GetStateFieldNames(), base::NumStateFields(), and base::SetStateFields().

◆ numStateVar

int numStateVar

protected

Definition at line 370 of file State.H.

Referenced by base::Copy(), base::CopyStateData(), base::Destroy(), base::NumStateVar(), and base::SetStateFields().

◆ stateFieldIndices

std::vector<int> stateFieldIndices

protected

total number of components in unsteady state

Definition at line 371 of file State.H.

Referenced by base::Copy(), base::CopyStateData(), base::Destroy(), base::GetStateFieldData(), base::GetStateFieldIndex(), base::GetStateFieldNames(), base::NumStateFieldComponents(), base::operator*=(), base::operator+=(), base::operator-=(), base::Report(), base::SetStateFields(), base::StateFieldIndices(), and base::Zero().

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

Detailed Description

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ base() [1/2]

◆ base() [2/2]

Member Function Documentation

◆ Alias()

◆ ConfigureState()

◆ Copy() [1/2]

◆ Copy() [2/2]

◆ CopyStateData()

◆ Destroy() [1/2]

◆ Destroy() [2/2]

◆ GetStateFieldData() [1/2]

◆ GetStateFieldData() [2/2]

◆ GetStateFieldIndex()

◆ GetStateFieldNames()

◆ NumStateFieldComponents()

◆ NumStateFields()

◆ NumStateVar()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator=()

◆ Report()

◆ ReportMeta()

◆ SetStateFields() [1/3]

◆ SetStateFields() [2/3]

◆ SetStateFields() [3/3]

◆ StateFieldIndices()

◆ Zero()

Member Data Documentation

◆ numStateFields

◆ numStateVar

◆ stateFieldIndices