gmValueInfo.h File Reference

Declaration of the GmValueInfo class. More...

#include "gmCoreConfig.h"
#include "gmLog.h"
#include <QString>
#include <unit.h>

Include dependency graph for gmValueInfo.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	GmBcTagInfo
	A helper struct to store bc tag information. More...
class	GmValueInfo
	Auxiliar class used to store the definition of a value. It can be used to store informations about state variables, attributes and properties. More...

Macros
#define	GM_VALUE_INFO_DEFAULT_FORMAT_WIDTH   12
	Default number format width for a GmValueInfo object.
#define	GM_VALUE_INFO_DEFAULT_FORMAT   'f'
	Default number format type for a GmValueInfo object.
#define	GM_VALUE_INFO_DEFAULT_FORMAT_PREC   2
	Default number format precision for a GmValueInfo object.
#define	GM_VALUE_INFO_DEFAULT_FORMAT_STR   "12.2f"
	Default number format string.

Enumerations
enum	GmValueSetKind {   GM_NODE_COORDINATES, GM_NODE_ATTRIBUTE, GM_NODE_STATEVAR, GM_CELL_ATTRIBUTE,   GM_GAUSS_ATTRIBUTE, GM_PSET_PROPERTY, GM_BC_NODE_PROPERTY, GM_BC_BOUNDARY_PROPERTY,   GM_DS_ATTRIBUTE, GM_USER, GM_NUM_VALUESET_KIND }
	Type describing what kind of information is stored by a values set. More...
enum	GmStorageType {   GM_DOUBLE_TYPE, GM_FLOAT_TYPE, GM_INT32_TYPE, GM_INT16_TYPE,   GM_BYTE_TYPE, GM_UINT32_TYPE, GM_UINT16_TYPE, GM_UBYTE_TYPE }
	The desired storage type for the data. More...
enum	GmDimType { GM_SCALAR_VALUE, GM_VECTOR_VALUE, GM_MATRIX_VALUE }
	Value dimension type. More...
enum	GmAllocMode { GM_ALLOC_FULL, GM_ALLOC_SPARSE, GM_ALLOC_AUTO }
	Type describing how the data space should be allocated. More...
enum	GmAllocStrategy { GM_STRATEGY_AUTO, GM_STRATEGY_SPARSE_HASH, GM_STRATEGY_SPARSE_LINKED, GM_STRATEGY_SPARSE_RLE }
	Allocation strategy for the stored data. More...
enum	GmAffectedNodes { GM_GEOMETRY_NODE, GM_GHOST_NODE, GM_BOTH }
	Affected node types for node based values (GM_NODE_COORDINATES, GM_NODE_ATTRIBUTE or GM_NODE_STATEVAR) More...

Detailed Description

Declaration of the GmValueInfo class.

Author

Carlos Augusto Teixeira Mendes

Date

april, 2015

Enumeration Type Documentation

GmAffectedNodes

enum GmAffectedNodes

Affected node types for node based values (GM_NODE_COORDINATES, GM_NODE_ATTRIBUTE or GM_NODE_STATEVAR)

Enumerator
GM_GEOMETRY_NODE	Specifies that this value exists over common geometry mesh nodes only.
GM_GHOST_NODE	Specifies that this value exists over ghost nodes only.
GM_BOTH	Specifies that this value exists over mesh and ghost nodes.

GmAllocMode

enum GmAllocMode

Type describing how the data space should be allocated.

Enumerator
GM_ALLOC_FULL	The data is NOT sparse and space should be fully preallocated.
GM_ALLOC_SPARSE	The data is sparse.
GM_ALLOC_AUTO	The data is NOT sparse but should be allocated only when the first non default value is written.

GmAllocStrategy

enum GmAllocStrategy

Allocation strategy for the stored data.

Enumerator
GM_STRATEGY_AUTO	Framework defined strategy.
GM_STRATEGY_SPARSE_HASH	Sparse data is stored in a hash table.
GM_STRATEGY_SPARSE_LINKED	Sparse data is stored as a linked list.
GM_STRATEGY_SPARSE_RLE	Sparse data is stored as run lenght encoded blocks.

GmDimType

enum GmDimType

Value dimension type.

Enumerator
GM_SCALAR_VALUE	Means that the value is a scalar number.
GM_VECTOR_VALUE	Means that the value is a 1D vector of numbers.
GM_MATRIX_VALUE	Means that the value is a 2D matrix of numbers.

GmStorageType

enum GmStorageType

The desired storage type for the data.

Enumerator
GM_DOUBLE_TYPE	Values are a double.
GM_FLOAT_TYPE	Values are a single precision float.
GM_INT32_TYPE	Values are a signed 32 bits integer.
GM_INT16_TYPE	Values are a signed 16 bits integer.
GM_BYTE_TYPE	Values are a signed 8 bits integer.
GM_UINT32_TYPE	Values are a unsigned 32 bits integer.
GM_UINT16_TYPE	Values are a unsigned 16 bits integer.
GM_UBYTE_TYPE	Values are a unsigned 8 bits integer.

GmValueSetKind

enum GmValueSetKind

Type describing what kind of information is stored by a values set.

Enumerator
GM_NODE_COORDINATES	This value set stores coordinates attached to nodes.
GM_NODE_ATTRIBUTE	This value set stores attributes attached to nodes.
GM_NODE_STATEVAR	This value set stores state variables attached to nodes.
GM_CELL_ATTRIBUTE	This value set stores attributes attached to cells.
GM_GAUSS_ATTRIBUTE	This value set stores attributes attached to Gauss points.
GM_PSET_PROPERTY	This value set stores properties attached to a property set.
GM_BC_NODE_PROPERTY	This value set stores properties attached to a node for a boundary condition.
GM_BC_BOUNDARY_PROPERTY	This value set stores properties attached to a boundary (edge or face) for a boundary condition.
GM_DS_ATTRIBUTE	This value set stores attributes attached to discontinuity sets.
GM_USER	Other kinds of value set used by the Gui / extensions.