MFC:Pre_process  v1.0
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 (dflt_int)
 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. More...
 
subroutine, public s_generate_parallel_grid (dflt_int)
 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. More...
 
subroutine, public s_initialize_grid_module ()
 Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module. More...
 
subroutine, public s_finalize_grid_module ()
 Deallocation procedures for the module. More...
 

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.

Definition at line 355 of file m_grid.f90.

Here is the caller graph for this function:

◆ s_generate_parallel_grid()

subroutine, public m_grid::s_generate_parallel_grid ( integer, intent(in)  dflt_int)

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.

Parameters
dflt_intis she default null integer used for checking initializationss

Definition at line 227 of file m_grid.f90.

Here is the caller graph for this function:

◆ s_generate_serial_grid()

subroutine, public m_grid::s_generate_serial_grid ( integer, intent(in)  dflt_int)

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.

Parameters
dflt_intis the default null integer used for checking initializationss

Definition at line 89 of file m_grid.f90.

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.

Definition at line 344 of file m_grid.f90.

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()

Definition at line 77 of file m_grid.f90.