Scrambler  1
ChomboDeclarations Module Reference

Declarations file for the Chombo output format. More...

+ Collaboration diagram for ChomboDeclarations:

List of all members.

Data Types

type  ChomboHandle
 An object containing information used to manage an hdf5 chombo file. More...

Public Member Functions

subroutine CreateChomboHandle (filename, chandle, lWrite)
 Allocates a new Chombo handle object and opens a file with it.
subroutine ClearChomboHandleOffsets (chandle)
 Resets all offsets in the given handle to 0.
subroutine CloseChomboHandle (chandle)
 Deallocates and nullifies a Chombo handle. This process includes closing the root group and file.
subroutine IO_GetLevelName (level, level_name)
 Takes a level and returns a Chombo-style level_group name.
subroutine IO_OpenCurrentLevel (chandle, level)
 Opens a level group handle and associates it with the level ID in the Chombo handle.
subroutine IO_CloseCurrentLevel (chandle)
 Closes the level group associated with a chombo file.
subroutine IO_CacheNodeBox (chandle, box_array, proc_id)
 Creates a new NodeBox object within the chombo handle's box list array.
subroutine IO_CacheChildNodeBox (chandle, box_array, proc_id)
 Creates a new NodeBox object within the chombo handle's child box list array.
subroutine IO_ClearAllNodeBoxes (chandle)
 Deletes all node boxes associated with a chombo handle.
subroutine IO_ClearAllChildBoxes (chandle)
 Deletes all child node boxes associated with a chombo handle.
subroutine IO_GetBoxFromChomboFile (chandle, box_set_name, box)
 Extract a grid box from an active chombo file.
subroutine IO_GetQDataFromChomboFile (chandle, mGlobal, qdata)
 Extract the cell-centered data (the q data) for a grid from a chombo file.
subroutine IO_GetAuxDataFromChomboFile (chandle, mGlobal, auxdata)
 Extract the face-centered data (the aux data) for a grid from a chombo file.
subroutine IO_GetCostMapFromChomboFile (chandle, mGlobal, level, costmap)
 Extract cost map for a grid from a chombo file.
subroutine IO_GetChildBoxCountFromChomboFile (chandle, child_count)
 Extract a single child-count (integer element) for a grid from a chombo file.
subroutine ChomboReCreateChildren (node, level, nChildren, chombo_childboxes)
 Assessing child_proclists and proctimes and mpi_id's given the.
INTEGER function Chombo_OpenSourceGroup (chandle, source_name)
 Opens a new file group using the source group handle within a ChomboHandle object.
subroutine Chombo_CloseSourceGroup (chandle)
 Closes the source group handle within a ChomboHandle object.
INTEGER function Chombo_OpenParticleGroup (chandle)
 Opens a new file group using the particle group handle within a ChomboHandle object.
subroutine Chombo_CloseParticleGroup (chandle)
 Closes the particle group handle within a ChomboHandle object.
INTEGER function Chombo_LevelChildCount (chandle, level)
 Returns the number of children on the next level.

Public Attributes

LOGICAL, parameter CHOMBO_HANDLE_READ = .FALSE.
LOGICAL, parameter CHOMBO_HANDLE_WRITE = .TRUE.
INTEGER, parameter COOLING_SOURCE_WRITE = 0
INTEGER, parameter CYLINDRICAL_SOURCE_WRITE = 1
INTEGER, parameter COOLING_SOURCE_READ = 2
INTEGER, parameter CYLINDRICAL_SOURCE_READ = 3
INTEGER, parameter CHOMBO_ROOT_LEVEL = -2
INTEGER, parameter CHOMBO_DOMAIN_LEVEL = -1
TYPE(ChomboHandle), pointer curr_handle

Detailed Description

Declarations file for the Chombo output format.

Author:
Brandon D. Shroyer
Date:
10-12-2010

Definition at line 34 of file chombo_declarations.f90.


Member Function/Subroutine Documentation

subroutine CreateChomboHandle ( CHARACTER(LEN=*)  filename,
TYPE(ChomboHandle), pointer  chandle,
LOGICAL  lWrite 
)

Allocates a new Chombo handle object and opens a file with it.

Parameters:
filenameThe name of the file being opened.
chandleA pointer to a chombo handle object.
lWriteA logical flag that when true opens a file for write access

Definition at line 100 of file chombo_declarations.f90.

subroutine ClearChomboHandleOffsets ( TYPE(ChomboHandle), pointer  chandle)

Resets all offsets in the given handle to 0.

Parameters:
chandleAn active chombo handle.

Definition at line 180 of file chombo_declarations.f90.

subroutine CloseChomboHandle ( TYPE(ChomboHandle), pointer  chandle)

Deallocates and nullifies a Chombo handle. This process includes closing the root group and file.

Parameters:
chandleA pointer to a chombo handle object that will be destroyed.

Definition at line 195 of file chombo_declarations.f90.

subroutine IO_GetLevelName ( INTEGER  level,
CHARACTER(LEN=*)  level_name 
)

Takes a level and returns a Chombo-style level_group name.

Parameters:
levelAn non-negative integer representing a level.
level_nameA character string to hold the level name.

Definition at line 230 of file chombo_declarations.f90.

subroutine IO_OpenCurrentLevel ( TYPE(ChomboHandle), pointer  chandle,
INTEGER  level 
)

Opens a level group handle and associates it with the level ID in the Chombo handle.

Parameters:
chandleA ChomboHandle pointer.
levelThe level of the group to be opened.

Definition at line 255 of file chombo_declarations.f90.

subroutine IO_CloseCurrentLevel ( TYPE(ChomboHandle), pointer  chandle)

Closes the level group associated with a chombo file.

Parameters:
chandleA ChomboHandle pointer.

Definition at line 294 of file chombo_declarations.f90.

subroutine IO_CacheNodeBox ( TYPE(ChomboHandle), pointer  chandle,
INTEGER, dimension(3,2)  box_array,
INTEGER  proc_id 
)

Creates a new NodeBox object within the chombo handle's box list array.

Parameters:
chandleAn active chombo handle object.
box_arrayA 3x2 grid coordinate array.
proc_idAn MPI processor rank.

Definition at line 309 of file chombo_declarations.f90.

subroutine IO_CacheChildNodeBox ( TYPE(ChomboHandle), pointer  chandle,
INTEGER, dimension(3,2)  box_array,
INTEGER  proc_id 
)

Creates a new NodeBox object within the chombo handle's child box list array.

Parameters:
chandleAn active chombo handle object.
box_arrayA 3x2 grid coordinate array.
proc_idAn MPI processor rank.

Definition at line 327 of file chombo_declarations.f90.

subroutine IO_ClearAllNodeBoxes ( TYPE(ChomboHandle), pointer  chandle)

Deletes all node boxes associated with a chombo handle.

Parameters:
chandleAn active chombo handle.

Definition at line 343 of file chombo_declarations.f90.

subroutine IO_ClearAllChildBoxes ( TYPE(ChomboHandle), pointer  chandle)

Deletes all child node boxes associated with a chombo handle.

Parameters:
chandleAn active chombo handle.

Definition at line 358 of file chombo_declarations.f90.

subroutine IO_GetBoxFromChomboFile ( TYPE(ChomboHandle), pointer  chandle,
CHARACTER(LEN=*)  box_set_name,
INTEGER, dimension(3,2)  box 
)

Extract a grid box from an active chombo file.

Parameters:
chandleAn active chombo handle.
box_set_nameString describing box set
boxA 3x2 integer array to be filled with a grid box.

Definition at line 375 of file chombo_declarations.f90.

subroutine IO_GetQDataFromChomboFile ( TYPE(ChomboHandle), pointer  chandle,
INTEGER, dimension(3,2)  mGlobal,
REAL(KIND=qPrec), dimension(:,:,:,:), pointer  qdata 
)

Extract the cell-centered data (the q data) for a grid from a chombo file.

Parameters:
chandleAn active chombo handle.
mGlobalThe boundaries of the grid whose data we are retrieving.
qdataThe 4D data array we will initialize.

Definition at line 413 of file chombo_declarations.f90.

subroutine IO_GetAuxDataFromChomboFile ( TYPE(ChomboHandle), pointer  chandle,
INTEGER, dimension(3,2)  mGlobal,
REAL(KIND=qPrec), dimension(:,:,:,:), pointer  auxdata 
)

Extract the face-centered data (the aux data) for a grid from a chombo file.

Parameters:
chandleAn active chombo handle.
mGlobalThe boundaries of the grid whose data we are retrieving.
auxdataThe 4D data array we will initialize.

Definition at line 462 of file chombo_declarations.f90.

subroutine IO_GetCostMapFromChomboFile ( TYPE(ChomboHandle), pointer  chandle,
INTEGER, dimension(3,2)  mGlobal,
INTEGER  level,
REAL(KIND=qPrec), dimension(:,:,:,:), pointer  costmap 
)

Extract cost map for a grid from a chombo file.

Parameters:
chandleAn active chombo handle.
mGlobalThe boundaries of the grid whose data we are retrieving.
levelThe level of the data we are retrieving.
costmapThe 4D data array we will initialize.

Definition at line 530 of file chombo_declarations.f90.

subroutine IO_GetChildBoxCountFromChomboFile ( TYPE(ChomboHandle), pointer  chandle,
INTEGER  child_count 
)

Extract a single child-count (integer element) for a grid from a chombo file.

Parameters:
chandleAn active chombo handle.
child_countAn integer to hold the child count.

Definition at line 575 of file chombo_declarations.f90.

subroutine ChomboReCreateChildren ( TYPE(Nodedef), pointer  node,
INTEGER  level,
INTEGER  nChildren,
TYPE(NodeBoxList), pointer  chombo_childboxes 
)

Assessing child_proclists and proctimes and mpi_id's given the.

Definition at line 595 of file chombo_declarations.f90.

INTEGER function Chombo_OpenSourceGroup ( TYPE(ChomboHandle), pointer  chandle,
CHARACTER(LEN=*)  source_name 
)

Opens a new file group using the source group handle within a ChomboHandle object.

Parameters:
chandleAn active Chombo handle.
source_nameThe name of the source group to be opened.

This subroutine is called from the SourceControl module. It returns the number of source objects.

Definition at line 660 of file chombo_declarations.f90.

subroutine Chombo_CloseSourceGroup ( TYPE(ChomboHandle), pointer  chandle)

Closes the source group handle within a ChomboHandle object.

Parameters:
chandleAn active Chombo handle.

This subroutine is called from the SourceControl module.

Definition at line 681 of file chombo_declarations.f90.

INTEGER function Chombo_OpenParticleGroup ( TYPE(ChomboHandle), pointer  chandle)

Opens a new file group using the particle group handle within a ChomboHandle object.

Parameters:
chandleAn active Chombo handle.

This subroutine is called from the ParticleControl module. On a read operation it returns the number of source objects.

Definition at line 697 of file chombo_declarations.f90.

subroutine Chombo_CloseParticleGroup ( TYPE(ChomboHandle), pointer  chandle)

Closes the particle group handle within a ChomboHandle object.

Parameters:
chandleAn active Chombo handle.

This subroutine is called from the ParticleControl module.

Definition at line 723 of file chombo_declarations.f90.

INTEGER function Chombo_LevelChildCount ( TYPE(ChomboHandle), pointer  chandle,
INTEGER  level 
)

Returns the number of children on the next level.

Parameters:
chandleAn active Chombo handle.
levelThe level whose CHILDREN we are querying.

Definition at line 739 of file chombo_declarations.f90.


Member Data Documentation

LOGICAL, parameter CHOMBO_HANDLE_READ = .FALSE.

Definition at line 44 of file chombo_declarations.f90.

LOGICAL, parameter CHOMBO_HANDLE_WRITE = .TRUE.

Definition at line 45 of file chombo_declarations.f90.

INTEGER, parameter COOLING_SOURCE_WRITE = 0

Definition at line 47 of file chombo_declarations.f90.

INTEGER, parameter CYLINDRICAL_SOURCE_WRITE = 1

Definition at line 48 of file chombo_declarations.f90.

INTEGER, parameter COOLING_SOURCE_READ = 2

Definition at line 50 of file chombo_declarations.f90.

INTEGER, parameter CYLINDRICAL_SOURCE_READ = 3

Definition at line 51 of file chombo_declarations.f90.

INTEGER, parameter CHOMBO_ROOT_LEVEL = -2

Definition at line 53 of file chombo_declarations.f90.

INTEGER, parameter CHOMBO_DOMAIN_LEVEL = -1

Definition at line 54 of file chombo_declarations.f90.

TYPE(ChomboHandle), pointer curr_handle

Definition at line 93 of file chombo_declarations.f90.


The documentation for this module was generated from the following file:
 All Classes Files Functions Variables