Xdmf3 Fortran API

From XdmfWeb
Revision as of 14:15, 7 November 2014 by Burns (talk | contribs)
Jump to navigationJump to search

XdmfLogo1.gif

XDMF API

The Fortran interface for Xdmf has a vastly different workflow from the C++ API. The C++ API workflow starts from the root of a tree and builds up to the leaves. The workflow for XdmfFortran starts at the leaves and collapses down to the root.

After including Xdmf.f, the first thing that needs to occur is a call to XDMFINIT in order to set up the base root of the Xdmf tree, an object of the type XdmfDomain. 

 CALL XDMFINIT(obj, filename)

The location of the interface object is stored in obj. This obj variable is then passed to most calls to the Xdmf Interface to interact with the root and the objects that are being generated to be added to the root.

XdmfGridCollections

After setting up the base root, any grid collections added using XDMFADDGRIDCOLLECTION are added to the current root. After being added to the root, the grid collection is placed on top of the stack and take the place of the root they were added to.

Xdmf API Grid Collection Stack: 

Domain <-- top of stack

Add a Grid Collection to the tree: 

! Adding a Grid Collection named "Grid Collection" 
  CALL XDMFADDGRIDCOLLECTION(obj, "Grid Collection"//CHAR(0), &
       XDMF_GRID_COLLECTION_TYPE_TEMPORAL)

Xdmf API Grid Collection Stack: 

Grid Collection <-- top of stack
Domain

Another Grid Collection is added: 

! Adding a Grid Collection named "Grid Collection2" 
  CALL XDMFADDGRIDCOLLECTION(obj, "Grid Collection2"//CHAR(0), &
       XDMF_GRID_COLLECTION_TYPE_TEMPORAL)

Xdmf API Grid Collection Stack: 

Grid Collection2 <-- top of stack
Grid Collection
Domain

Calling XDMFCLOSEGRIDCOLLECTION removes a grid collection from the top of the stack. It is still connected to the grid collection below it (what is at the top of the stack after the call) and may be added back to the top of the stack using XDMFOPENDOMAINGRIDCOLLECTION.

Xdmf API Grid Collection Stack: 

Grid Collection2 <-- top of stack
Grid Collection
Domain

Remove a Grid Collection from the top of the stack: 

  CALL XDMFCLOSEGRIDCOLLECTION(obj, .TRUE.)

Xdmf API Grid Collection Stack: 

Grid Collection <-- top of stack
Domain

Returning a Grid Collection to the stack adds it to the top:

! Returning the Grid Collection contained in the domain at position 0 to the stack 

 CALL XDMFOPENDOMAINGRIDCOLLECTION(obj, 0, 1, 1, 1, 1)

Xdmf API Grid Collection Stack: 

Grid Collection2 <-- top of stack
Grid Collection
Domain

In order to add multiple grid collections to the same root XDMFCLOSEGRIDCOLLECTION must be called to remove the child from the stack before the new grid collection can be added.

Xdmf Tree represents the underlying Xml tree and c++ object structure created by the calls. 

CALL XDMFINIT(obj, filename)

Xdmf API Grid Collection Stack: 

Domain <-- top of stack

Xdmf Tree: 

Domain

! Adding a Grid Collection named "Grid Collection" 
  CALL XDMFADDGRIDCOLLECTION(obj, "Grid Collection"//CHAR(0), &
       XDMF_GRID_COLLECTION_TYPE_TEMPORAL)

Xdmf API Grid Collection Stack: 

Grid Collection <-- top of stack
Domain

Xdmf Tree: 

Domain
|->Grid Collection

! Adding a Grid Collection named "Grid Collection2" 

 CALL XDMFADDGRIDCOLLECTION(obj, "Grid Collection2"//CHAR(0), &
      XDMF_GRID_COLLECTION_TYPE_TEMPORAL)

Xdmf API Grid Collection Stack: 

Grid Collection2 <-- top of stack
Grid Collection
Domain

Xdmf Tree 

Domain
|->Grid Collection
   |->Grid Collection2

! Removing the grid Collection from the top of the stack. 

 CALL XDMFCLOSEGRIDCOLLECTION(obj, .TRUE.)

Xdmf API Grid Collection Stack: 

Grid Collection <-- top of stack
Domain

Xdmf Tree: 

Domain
|->Grid Collection
   |->Grid Collection2

! Adding a Grid Collection named "Grid Collection3" 
  CALL XDMFADDGRIDCOLLECTION(obj, "Grid Collection3"//CHAR(0), &
       XDMF_GRID_COLLECTION_TYPE_TEMPORAL)

Xdmf API Grid Collection Stack: 

Grid Collection3 <-- top of stack
Grid Collection
Domain

Xdmf Tree: 

Domain
|->Grid Collection
   |->Grid Collection2
   |->Grid Collection3

When generating Attributes, Information, Maps, and Sets the created items are simultaniously added to a work array and an archive array. Creating certain objects clears certain working arrays after adding the items contained within.

Object Working Arrays Cleared
GridCollection Attributes, Information, Maps, Sets
Grid Attributes, Information, Maps, Sets
Attribute Information
Information None
Map none
Set Attributes, Information

After an item is cleared from a working array, it can be added back either by calling the appropriate OPEN command or by adding it via its index in the archive array using the appropriate version of AddPrevious. The index of an object in the archive array is what is returned by the Add function when it is called. 

! Adding an attribute that is named "Attribute 1"
! Centered on Node
! Scalar type
! contains 12 float values loaded from myNodeAttribute
  nodeAttributeId = XDMFADDATTRIBUTE(obj, 'Attribute 1'//CHAR(0), &
       XDMF_ATTRIBUTE_CENTER_NODE, XDMF_ATTRIBUTE_TYPE_SCALAR, 12, &
       XDMF_ARRAY_TYPE_FLOAT64, myNodeAttribute)
Attribute Working Attribute Archive
Attribute 1 Attribute 1

Xdmf Tree: 

Attribute 1

! Adding an information named "Information 1"
  tempID = XDMFADDINFORMATION(obj, 'Information 1'//CHAR(0), 'This is Information 1'//CHAR(0))
Attribute Working Attribute Archive
Attribute 1 Attribute 1


Information Working Information Archive
Information 1 Information 1

Xdmf Tree: 

Attribute 1

Information 1

! Adding an attribute that is named "Attribute 2"
! Centered on Nodex
! Scalar type
! contains 12 float values loaded from myNodeAttribute
  nodeAttributeId = XDMFADDATTRIBUTE(obj, 'Attribute 2'//CHAR(0), &
       XDMF_ATTRIBUTE_CENTER_NODE, XDMF_ATTRIBUTE_TYPE_SCALAR, 12, &
       XDMF_ARRAY_TYPE_FLOAT64, myNodeAttribute)
Attribute Working Attribute Archive
Attribute 1 Attribute 1
Attribute 2 Attribute 2


Information Working Information Archive
Information 1

Xdmf Tree: 

Attribute 1

Attribute 2
|->Information 1

! Adding a set that is named "Set 1"
! A set of Node Type
! contains 12 float values loaded from myNodeAttribute
  testSetID = XDMFADDSET(obj, 'Set 1'//CHAR(0), XDMF_SET_TYPE_NODE, &
                         myNodeAttribute,  12, XDMF_ARRAY_TYPE_FLOAT64)
Attribute Working Attribute Archive
Attribute 1
Attribute 2


Information Working Information Archive
Information 1
Set Working Set Archive
Set 1 Set 1

Xdmf Tree: 

Set 1
|->Attribute 1
|->Attribute 2
    |->Information 1

! Adding an attribute that is named "Attribute 3"
! Centered on Node
! Scalar type
! contains 12 float values loaded from myNodeAttribute
  nodeAttributeId = XDMFADDATTRIBUTE(obj, 'Attribute 3'//CHAR(0), &
       XDMF_ATTRIBUTE_CENTER_NODE, XDMF_ATTRIBUTE_TYPE_SCALAR, 12, &
       XDMF_ARRAY_TYPE_FLOAT64, myNodeAttribute)
! Adding an Information named "Information 2"
  tempID = XDMFADDINFORMATION(obj, 'Information 2'//CHAR(0), 'This is Information 2'//CHAR(0))
Attribute Working Attribute Archive
Attribute 3 Attribute 1
Attribute 2
Attribute 3
Information Working Information Archive
Information 2 Information 1
Information 2
Set Working Set Archive
Set 1 Set 1

Xdmf Tree: 

Set 1
|->Attribute 1
|->Attribute 2
    |->Information 1

Attribute 3

Information 2

! Adding a grid named "Unstructured Grid"
  CALL XDMFADDGRID(obj, 'Unstructured Grid'//CHAR(0), .FALSE.)
Attribute Working Attribute Archive
Attribute 1
Attribute 2
Attribute 3
Information Working Information Archive
Information 1
Information 2
Set Working Set Archive
Set 1

Xdmf API Grid Collection Stack: 

Grid Collection3 <-- top of stack
Grid Collection
Domain

Xdmf Tree: 

Domain
|->Grid Collection
   |->Grid Collection2
   |->Grid Collection3
     |->Unstructured Grid
         |->Set 1
             |->Attribute 1
             |->Attribute 2
                 |->Information 1
         |->Attribute 3
         |->Information 2

If we wanted to add another grid with the same internal objects we would call the appropriate add previous methods to add them back into the working arrays. 

! Note: Using hard coded indecies here
!       the return value from any of the add functions
!       such as XdmfAddInformation may also be used
  CALL XDMFADDPREVIOUSATTRIBUTE(obj, 3)
  CALL XDMFADDPREVIOUSINFORMATION(obj, 2)
  CALL XDMFADDPREVIOUSSET(obj, 1)
Attribute Working Attribute Archive
Attribute 3 Attribute 1
Attribute 2
Attribute 3
Information Working Information Archive
Information 2 Information 1
Information 2
Set Working Set Archive
Set 1 Set 1

Xdmf API Grid Collection Stack: 

Grid Collection3 <-- top of stack
Grid Collection
Domain

Xdmf Tree: 

Set 1
|->Attribute 1
|->Attribute 2
   |->Information 1

Attribute 3

Information 2

Domain
|->Grid Collection
   |->Grid Collection2
   |->Grid Collection3
     |->Unstructured Grid
         |->Set 1
             |->Attribute 1
             |->Attribute 2
                 |->Information 1
         |->Attribute 3
         |->Information 2

Then we simply call add grid again to insert a grid with the current contents of the working arrays 

! Adding a grid named "Unstructured Grid 2"
  CALL XDMFADDGRID(obj, 'Unstructured Grid 2'//CHAR(0), .FALSE.)


Attribute Working Attribute Archive
Attribute 1
Attribute 2
Attribute 3
Information Working Information Archive
Information 1
Information 2
Set Working Set Archive
Set 1

Xdmf API Grid Collection Stack: 

Grid Collection3 <-- top of stack
Grid Collection
Domain

Xdmf Tree: 

Domain
|->Grid Collection
   |->Grid Collection2
   |->Grid Collection3
     |->Unstructured Grid
         |->Set 1
             |->Attribute 1
             |->Attribute 2
                 |->Information 1
         |->Attribute 3
         |->Information 2
     |->Unstructured Grid 2
         |->Set 1
             |->Attribute 1
             |->Attribute 2
                 |->Information 1
         |->Attribute 3
         |->Information 2
Retrieved from "http://www.xdmf.org/index.php?title=Xdmf3_Fortran_API&oldid=136"