core.xdmf.TemporalGrid Class Reference

A collection of XDMF Grid objects associated with time steps. More...

Inheritance diagram for core.xdmf.TemporalGrid:

Collaboration diagram for core.xdmf.TemporalGrid:

Public Member Functions
def	__init__ (self)
def	create_xml_element (self)
	Return the XDMF item as an XML element node in the XML document tree. More...
def	add_attribute (self, attr)
	Add an XDMF Attribute (results data set) to each child grid. More...
def	add_grid (self, time, grid)
	Add a child grid with a time step value. More...
Public Member Functions inherited from core.xdmf.Grid
def	xml_tag (self)
	Return the XML tag for the XDMF item as a string. More...

Public Attributes
	times
	grids

Detailed Description

A collection of XDMF Grid objects associated with time steps.

This allows time step values to be associated with a collection of
SpatialGrid objects.

Constructor & Destructor Documentation

__init__()

def core.xdmf.TemporalGrid.__init__

(

self

)

Member Function Documentation

add_attribute()

def core.xdmf.TemporalGrid.add_attribute	(		self,
			attr
	)

Add an XDMF Attribute (results data set) to each child grid.

Reimplemented from core.xdmf.Grid.

add_grid()

def core.xdmf.TemporalGrid.add_grid	(		self,
			time,
			grid
	)

Add a child grid with a time step value.

    Keyword arguments:
    time -- the XDMF time (see Time)
    grid -- the XDMF grid (see Grid)

create_xml_element()

def core.xdmf.TemporalGrid.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.

Member Data Documentation

grids

core.xdmf.TemporalGrid.grids

times

core.xdmf.TemporalGrid.times

---

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

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