core.xdmf.GeometrycalObjectData Class Reference

An XDMF Attribute for element data value container data. More...

Inheritance diagram for core.xdmf.GeometrycalObjectData:

Collaboration diagram for core.xdmf.GeometrycalObjectData:

Public Member Functions
def	name (self)
	A descriptive name of the results data. More...
def	center (self)
	Specifies where the data is centered. More...
def	attribute_type (self)
	Specifies the rank of the data. More...
def	__init__ (self, name, data)
	Construct the object. More...
def	create_xml_element (self)
	Return the XDMF item as an XML element node in the XML document tree. More...
Public Member Functions inherited from core.xdmf.Attribute
def	xml_tag (self)
	Return the XML tag for the XDMF item as a string. More...

Public Attributes
	data

Detailed Description

An XDMF Attribute for element data value container data.

Constructor & Destructor Documentation

__init__()

def core.xdmf.GeometrycalObjectData.__init__	(		self,
			name,
			data
	)

Construct the object.

    Keyword arguments:
    name -- the name of the results data, e.g., "PRESSURE"
    data -- the data item for the corresponding HDF5 data set

Reimplemented in core.xdmf.ConditionData, and core.xdmf.ElementData.

Member Function Documentation

attribute_type()

def core.xdmf.GeometrycalObjectData.attribute_type

(

self

)

Specifies the rank of the data.

    Options: "Scalar", "Vector", "Tensor", "Tensor6", "Matrix".

Reimplemented from core.xdmf.Attribute.

center()

def core.xdmf.GeometrycalObjectData.center

(

self

)

Specifies where the data is centered.

    Options: "Node", "Edge", "Face", "Cell", "Grid", "Other".

Reimplemented from core.xdmf.Attribute.

create_xml_element()

def core.xdmf.GeometrycalObjectData.create_xml_element

(

self

)

Return the XDMF item as an XML element node in the XML document tree.

    If the node is the root element of the XML document, it can be written
    to a file as:

    root = obj.create_xml_element()
    ElementTree(root).write(file_or_filename)

    If it is a child node, it can be appended to its parent as:

    child = obj.create_xml_element()
    parent.append(child)

    An entire XML document representing an XDMF model is built from a set
    of XdmfItem objects by combining their XML nodes in an XML tree.

Reimplemented from core.xdmf.XdmfItem.

name()

def core.xdmf.GeometrycalObjectData.name

(

self

)

A descriptive name of the results data.

    Example: "VELOCITY".

Reimplemented from core.xdmf.Attribute.

Member Data Documentation

data

core.xdmf.GeometrycalObjectData.data

---

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

• /home/runner/work/Documentation/Documentation/master/applications/HDF5Application/python_scripts/core/xdmf.py