Scrambler  1
IOChombo Module Reference

Provides a formaIOCommst-agnostic interface for AstroBEAR to read and write data files. More...

List of all members.

Public Member Functions

subroutine, public MakeChomboFile (nframe)
 Writes the current data frame to an HDF file using a modified Chombo specification.
subroutine IO_WriteBoxToChomboFile (chandle, box_set_name, box)
 Writes a box to a named dataset within the active chombo file.
subroutine, public ChomboReloadLevel (level)
 A recursive subroutine that reads in chombo restart data for the given level.
subroutine, public ChomboRestartInit (nframe)
 Begins the process of restarting from the nframe-th chombo file.
subroutine, public ChomboRestartFinalize (nframe)
subroutine WriteCoolingObjects (chandle)
 Creates a group for cooling data within the Chombo file and populates it with the contents of the cooling objects list.

Private Member Functions

subroutine IO_WriteChildCountToChomboFile (chandle, int_data)
 Writes a single integer to the childbox_count dataset within the active chombo file.
subroutine IO_WriteDomainData (chandle, master_childcount)
 Collects box and cost map data for level -1 and writes it to the chombo file.
subroutine IO_ReadInLevelData (chandle, level)
 Reads in the boxes and childboxes data for the level. On the root level, it also pulls costmap.
subroutine WritePointGravityObjects (chandle)
 Creates a group for particle data within the Chombo file and populates it with the contents of the SinkParticles list.

Detailed Description

Provides a formaIOCommst-agnostic interface for AstroBEAR to read and write data files.

Author:
Brandon D. Shroyer
Date:
7-9-2010

Definition at line 38 of file io_chombo.f90.


Member Function/Subroutine Documentation

subroutine, public MakeChomboFile ( INTEGER, intent(in)  nframe)

Writes the current data frame to an HDF file using a modified Chombo specification.

Parameters:
nframethe number of the sequence frame being written.
Returns:
time spent generating the chombo file.

Definition at line 68 of file io_chombo.f90.

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

Writes a box to a named dataset within the active chombo file.

Parameters:
chandleThe handle for the active chombo file.
box_set_nameThe name of the dataset being written to.
boxThe box array to be written.

Definition at line 913 of file io_chombo.f90.

subroutine IO_WriteChildCountToChomboFile ( TYPE(ChomboHandle), pointer  chandle,
INTEGER  int_data 
) [private]

Writes a single integer to the childbox_count dataset within the active chombo file.

Parameters:
chandleThe handle for the active chombo file.
int_dataThe integer data to be written.

Definition at line 960 of file io_chombo.f90.

subroutine IO_WriteDomainData ( TYPE(ChomboHandle), pointer  chandle,
INTEGER  master_childcount 
) [private]

Collects box and cost map data for level -1 and writes it to the chombo file.

Parameters:
chandleAn active chombo handle.
master_childcountNumber of master children

Definition at line 978 of file io_chombo.f90.

subroutine IO_ReadInLevelData ( TYPE(ChomboHandle), pointer  chandle,
INTEGER  level 
) [private]

Reads in the boxes and childboxes data for the level. On the root level, it also pulls costmap.

Parameters:
chandleAn active Chombo handle.
levelThe level of the data being pulled.

Definition at line 1130 of file io_chombo.f90.

subroutine, public ChomboReloadLevel ( INTEGER  level)

A recursive subroutine that reads in chombo restart data for the given level.

Parameters:
chandleAn active chombo handle.
levelThe level being read in.

Definition at line 1236 of file io_chombo.f90.

subroutine, public ChomboRestartInit ( INTEGER  nframe)

Begins the process of restarting from the nframe-th chombo file.

Parameters:
nframeThe frame number to restart from.

Definition at line 1341 of file io_chombo.f90.

subroutine, public ChomboRestartFinalize ( INTEGER  nframe)

Definition at line 1371 of file io_chombo.f90.

subroutine WritePointGravityObjects ( TYPE(ChomboHandle), pointer  chandle) [private]

Creates a group for particle data within the Chombo file and populates it with the contents of the SinkParticles list.

Parameters:
chandleA chombo file handle.

Definition at line 1381 of file io_chombo.f90.

subroutine WriteCoolingObjects ( TYPE(ChomboHandle), pointer  chandle)

Creates a group for cooling data within the Chombo file and populates it with the contents of the cooling objects list.

Parameters:
chandleA chombo file handle.

Definition at line 1433 of file io_chombo.f90.


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