m_grid Module Reference

This module takes care of creating the rectilinear grid on which the data for the initial condition will be laid out and on which the simulation will eventually be computed. The grid may either be uniform or non-uniform. Non-uniform grids are generated using the hyperbolic tangent function, see Johnsen (2007) for details. Alternatively to synthesizing a new grid, the user may select to read in a preexisting one. This is carried out through the module m_start_up.f90. In such a case, the responsibility of this module becomes only to allocate/deallocate the necessary grid variables for the cell-centers and cell-boundaries locations. More...

Data Types
interface	s_generate_abstract_grid

Functions/Subroutines
subroutine, public	s_generate_serial_grid
	The following subroutine generates either a uniform or non-uniform rectilinear grid in serial, defined by the parameters inputted by the user. The grid information is stored in the grid variables containing coordinates of the cell- centers and cell-boundaries.
subroutine, public	s_generate_parallel_grid
	The following subroutine generates either a uniform or non-uniform rectilinear grid in parallel, defined by the parameters inputted by the user. The grid information is stored in the grid variables containing coordinates of the cell- centers and cell-boundaries.
subroutine, public	s_initialize_grid_module
	Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module.
subroutine, public	s_finalize_grid_module
	Deallocation procedures for the module.

Variables
procedure(s_generate_abstract_grid), pointer, public	s_generate_grid => null()

Detailed Description

This module takes care of creating the rectilinear grid on which the data for the initial condition will be laid out and on which the simulation will eventually be computed. The grid may either be uniform or non-uniform. Non-uniform grids are generated using the hyperbolic tangent function, see Johnsen (2007) for details. Alternatively to synthesizing a new grid, the user may select to read in a preexisting one. This is carried out through the module m_start_up.f90. In such a case, the responsibility of this module becomes only to allocate/deallocate the necessary grid variables for the cell-centers and cell-boundaries locations.

Function/Subroutine Documentation

s_finalize_grid_module()

subroutine, public m_grid::s_finalize_grid_module

Deallocation procedures for the module.

Here is the caller graph for this function:

s_generate_parallel_grid()

subroutine, public m_grid::s_generate_parallel_grid

The following subroutine generates either a uniform or non-uniform rectilinear grid in parallel, defined by the parameters inputted by the user. The grid information is stored in the grid variables containing coordinates of the cell- centers and cell-boundaries.

Here is the caller graph for this function:

s_generate_serial_grid()

subroutine, public m_grid::s_generate_serial_grid

The following subroutine generates either a uniform or non-uniform rectilinear grid in serial, defined by the parameters inputted by the user. The grid information is stored in the grid variables containing coordinates of the cell- centers and cell-boundaries.

Here is the call graph for this function:

Here is the caller graph for this function:

s_initialize_grid_module()

subroutine, public m_grid::s_initialize_grid_module

Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

s_generate_grid

procedure(s_generate_abstract_grid), pointer, public m_grid::s_generate_grid => null()