An IRegularGrid3DComponentItem represents an IRegularGrid3D IComponentItem. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IRegularGrid3DComponentDataItem:

Collaboration diagram for HydroCouple::Spatial::IRegularGrid3DComponentDataItem:

Public Member Functions
virtual	~IRegularGrid3DComponentDataItem ()=0
	~IRegularGrid3DComponentItem. More...

virtual IRegularGrid3D *	grid () const =0
	IRegularGrid3D grid associated with this IRegularGrid3DComponentItem. More...

virtual MeshDataType	meshDataType () const =0
	meshDataType More...

virtual IDimension *	xCellDimension () const =0
	Number of X cells IDimension. More...

virtual IDimension *	yCellDimension () const =0
	Number of Y cells IDimension. More...

virtual IDimension *	zCellDimension () const =0
	Number of Z cells IDimension. More...

virtual IDimension *	cellFaceDimension () const =0
	cellFaceDimension 0 = Top , 1 = Bottom, 2 = left , 3 = Right, Up = 4, Down = 5 More...

virtual IDimension *	cellNodeDimension () const =0
	cellNodeDimension Node indices start from the bottom left and go in a counter clockwise order. More...

virtual void	getValue (int xCellIndex, int yCellIndex, int zCellIndex, int cellFaceIndex, int cellNodeIndex, void *data) const =0
	getValue for given x cell index, y cell index, z cell index, face index, and node index. More...

virtual void	setValue (int xCellIndex, int yCellIndex, int zCellIndex, int cellFaceIndex, int cellNodeIndex, const void *data)=0
	setValue for given x cell index, y cell index, z cell index, face index, and node index. More...

Public Member Functions inherited from HydroCouple::IComponentDataItem
virtual	~IComponentDataItem ()=0
	IComponentDataItem::~IComponentDataItem is a virtual destructor. More...

virtual IModelComponent *	modelComponent () const =0
	Gets the owner IModelComponent of this IComponentItem. For an IOutput component item this is the component responsible for providing the content of the IOutput. More...

virtual vector< IDimension * >	dimensions () const =0
	provides purely descriptive information of the dimensions associated with this IComponentItem More...

virtual int	dimensionLength (const vector< int > &dimensionIndexes) const =0
	dimensionLength returns the length of the dimension specified by the given dimension indexes. To get the size of the first dimension, use a null integer array as input argument. Length of indices must be a least one smaller than the numDimensions() More...

virtual IValueDefinition *	valueDefinition () const =0
	IValueDefinition for this IValueSet defines the variable type associated with this object. More...

virtual void	getValue (const vector< int > &dimensionIndexes, void *data) const =0
	Gets a multi-dimensional array of value for given dimension indexes. IndexArray = x + y * InSizeX + z * InSizeX * InSizeY etc;. More...

virtual void	setValue (const vector< int > &dimensionIndexes, const void *data)=0
	Sets a multi-dimensional array of values for given dimension indexes. More...

virtual bool	hasEditor () const =0
	hasEditor indicates whether this IComponentItem has a UI editor. More...

virtual void	showEditor ()=0
	showEditor shows the editor for this IComponentItem. More...

virtual bool	hasViewer () const =0
	hasViewer indicates whether this IComponentItem has a UI viewer. More...

virtual void	showViewer ()=0
	showViewer More...

Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=0
	IIdentity::~IIdentity is a virtual destructor. More...

virtual string	id () const =0
	Gets a unique identifier for the entity. More...

Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=0
	IDescription::~IDescription is a virtual destructor. More...

virtual string	caption () const =0
	Gets caption for the entity. More...

virtual void	setCaption (const string &caption)=0
	Sets caption for the entity. More...

virtual string	description () const =0
	Gets additional descriptive information for the entity. More...

virtual void	setDescription (const string &description)=0
	Gets additional descriptive information for the entity. More...

Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=0
	IPropertyChanged::~IPropertyChanged is a virtual destructor. More...

virtual void	registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
	IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...

virtual void	deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
	IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object changes. More...

Detailed Description

An IRegularGrid3DComponentItem represents an IRegularGrid3D IComponentItem.

Constructor & Destructor Documentation

◆ ~IRegularGrid3DComponentDataItem()

virtual HydroCouple::Spatial::IRegularGrid3DComponentDataItem::~IRegularGrid3DComponentDataItem ( )

pure virtual

~IRegularGrid3DComponentItem.

Member Function Documentation

◆ cellFaceDimension()

virtual IDimension* HydroCouple::Spatial::IRegularGrid3DComponentDataItem::cellFaceDimension ( ) const

pure virtual

cellFaceDimension 0 = Top , 1 = Bottom, 2 = left , 3 = Right, Up = 4, Down = 5

Returns: The dimension for the cell faces.

◆ cellNodeDimension()

virtual IDimension* HydroCouple::Spatial::IRegularGrid3DComponentDataItem::cellNodeDimension ( ) const

pure virtual

cellNodeDimension Node indices start from the bottom left and go in a counter clockwise order.

Returns: The dimension for the cell nodes.

◆ getValue()

virtual void HydroCouple::Spatial::IRegularGrid3DComponentDataItem::getValue	(	int	xCellIndex,
		int	yCellIndex,
		int	zCellIndex,
		int	cellFaceIndex,
		int	cellNodeIndex,
		void *	data
	)		const

pure virtual

getValue for given x cell index, y cell index, z cell index, face index, and node index.

Parameters

xCellIndex	is the x cell index from where to obtain the requested data.
yCellIndex	is the y cell index from where to obtain the requested data.
zCellIndex	is the z cell index from where to obtain the requested data.
cellFaceIndex	is the cell face index from where to obtain the requested data.
cellNodeIndex	is the cell node index from where to obtain the requested data.
data	is a pointer to data that is to be written. Must be allocated beforehand with the correct data type.

◆ grid()

virtual IRegularGrid3D* HydroCouple::Spatial::IRegularGrid3DComponentDataItem::grid ( ) const

pure virtual

IRegularGrid3D grid associated with this IRegularGrid3DComponentItem.

◆ meshDataType()

virtual MeshDataType HydroCouple::Spatial::IRegularGrid3DComponentDataItem::meshDataType ( ) const

pure virtual

meshDataType

Returns: The type of mesh data.

◆ setValue()

virtual void HydroCouple::Spatial::IRegularGrid3DComponentDataItem::setValue	(	int	xCellIndex,
		int	yCellIndex,
		int	zCellIndex,
		int	cellFaceIndex,
		int	cellNodeIndex,
		const void *	data
	)

pure virtual

setValue for given x cell index, y cell index, z cell index, face index, and node index.

Parameters

xCellIndex	is the x cell index from where to write data.
yCellIndex	is the y cell index from where to write data.
zCellIndex	is the z cell index from where to write data.
cellFaceIndex	is the cell face index from where to write data.
cellNodeIndex	is the cell node index from where to write data.
data	is a pointer data thata to is to be copied

◆ xCellDimension()

virtual IDimension* HydroCouple::Spatial::IRegularGrid3DComponentDataItem::xCellDimension ( ) const

pure virtual

Number of X cells IDimension.

◆ yCellDimension()

virtual IDimension* HydroCouple::Spatial::IRegularGrid3DComponentDataItem::yCellDimension ( ) const

pure virtual

Number of Y cells IDimension.

◆ zCellDimension()

virtual IDimension* HydroCouple::Spatial::IRegularGrid3DComponentDataItem::zCellDimension ( ) const

pure virtual

Number of Z cells IDimension.

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

/home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocouplespatial.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IRegularGrid3DComponentDataItem()

Member Function Documentation

◆ cellFaceDimension()

◆ cellNodeDimension()

◆ getValue()

◆ grid()

◆ meshDataType()

◆ setValue()

◆ xCellDimension()

◆ yCellDimension()

◆ zCellDimension()