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

Used by

  • module~~tem_general_module~~UsedByGraph module~tem_general_module tem_general_module program~tem_face_test~2 tem_face_test program~tem_face_test~2->module~tem_general_module module~tem_utestenv_module tem_utestEnv_module program~tem_face_test~2->module~tem_utestenv_module program~tem_varsys_stfunvar_test tem_varSys_stfunVar_test program~tem_varsys_stfunvar_test->module~tem_general_module program~tem_varsys_stfunvar_test->module~tem_utestenv_module program~tem_face_test tem_face_test program~tem_face_test->module~tem_general_module program~tem_face_test->module~tem_utestenv_module program~tem_logical_opertor_test tem_logical_opertor_test program~tem_logical_opertor_test->module~tem_general_module program~tem_logical_opertor_test->module~tem_utestenv_module program~tem_variable_combine_test tem_variable_combine_Test program~tem_variable_combine_test->module~tem_general_module program~tem_variable_combine_test->module~tem_utestenv_module program~tem_sparta_test tem_sparta_test program~tem_sparta_test->module~tem_general_module program~tem_sparta_test->module~tem_utestenv_module program~tem_variable_extract_test tem_variable_extract_test program~tem_variable_extract_test->module~tem_general_module program~tem_variable_extract_test->module~tem_utestenv_module program~tem_spacetime_fun_test tem_spacetime_fun_test program~tem_spacetime_fun_test->module~tem_general_module program~tem_spacetime_fun_test->module~tem_utestenv_module program~tem_varsys_test tem_varSys_test program~tem_varsys_test->module~tem_general_module program~tem_varsys_test->module~tem_utestenv_module program~tem_varsys_opvar_test tem_varSys_opVar_test program~tem_varsys_opvar_test->module~tem_general_module program~tem_varsys_opvar_test->module~tem_utestenv_module program~tem_variable_evaltype_test tem_variable_evaltype_test program~tem_variable_evaltype_test->module~tem_general_module program~tem_variable_evaltype_test->module~tem_utestenv_module program~tem_face_test~3 tem_face_test program~tem_face_test~3->module~tem_general_module program~tem_face_test~3->module~tem_utestenv_module program~tem_varsys_derivevar_test tem_varSys_deriveVar_test program~tem_varsys_derivevar_test->module~tem_general_module program~tem_varsys_derivevar_test->module~tem_utestenv_module program~tem_varsys_statevar_test tem_varSys_stateVar_test program~tem_varsys_statevar_test->module~tem_general_module program~tem_varsys_statevar_test->module~tem_utestenv_module module~tem_utestenv_module->module~tem_general_module program~bin_search_test bin_search_test program~bin_search_test->module~tem_general_module

Contents


Derived Types

type, public :: tem_general_type

Global parameter type contains all general information needed for all solvers

Components

TypeVisibilityAttributesNameInitial
type(tem_solveHead_type), private :: solver

General description of the deployed solver.

type(tem_simControl_type), private :: simControl

contains current simulation time, timeControl, abortCriteria and simulation status

type(tem_comm_env_type), private :: proc

MPI communication enviroment including MPI communicator.

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

MPI communication pattern type.

type(tem_restart_type), private :: restart

Global restart type

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

Load balancing information.

Read more…
character(len=pathLen), private :: 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

TypeIntentOptionalAttributesName
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.

See tem_abortCriteria_module for details on this additional abortCriteria parameters, that the solver may define to be loaded from the configuration.

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

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

Arguments

TypeIntentOptionalAttributesName
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

TypeIntentOptionalAttributesName
type(tem_general_type), intent(in) :: general

encapsulates global parameters which are common for all solvers