tem_general_module Module

Initialize general infrastructure settings of treelm.

This module provides a central point to initialize the various general settings in treelm.


Uses


Derived Types

type, public ::  tem_general_type

Global parameter type contains all general information needed for all solvers

Components

Type Visibility Attributes Name Initial
type(tem_solveHead_type), public :: solver

General description of the deployed solver.

type(tem_simControl_type), public :: simControl

contains current simulation time, timeControl, abortCriteria and simulation status

type(tem_comm_env_type), public :: proc

MPI communication enviroment including MPI communicator.

Read more…
type(tem_commPattern_type), public :: commPattern

MPI communication pattern type.

type(tem_restart_type), public :: restart

Global restart type

Read more…
type(tem_balance_type), public :: balance

Load balancing information.

Read more…
character(len=pathLen), public :: timingFile

Filename for solver timing output


Subroutines

public subroutine tem_load_general(me, conf, timingFile, solverAborts)

Load general treelm settings from the Lua script in conf.

Arguments

Type IntentOptional Attributes Name
type(tem_general_type), intent(inout) :: me

global general parameter

type(flu_State) :: conf

Handle to the Lua script containing the configuration.

character(len=*), intent(in), optional :: timingFile

Default timing filename provided by the caller, overwritten by config file.

class(tem_solverAborts_type), intent(inout), optional :: solverAborts

Solver specific abort criteria to load.

Read more…

public subroutine tem_start(codeName, version, general, comm, simControl)

Initialize the environment. Should be the very first call in the program.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: codeName

name of code

character(len=*), intent(in) :: version

version of the code

type(tem_general_type), intent(out) :: general

encapsulates global parameters which are common for all solvers

integer, intent(in), optional :: comm

mpi communicator if it is predefined as in apesmate

type(tem_simControl_type), intent(out), optional :: simControl

simulation control to initialize

public subroutine tem_finalize(general)

Finalize the environment, should be the very last call in the program.

Arguments

Type IntentOptional Attributes Name
type(tem_general_type), intent(in) :: general

encapsulates global parameters which are common for all solvers