Documentation for module mc_environment_types

contains the subroutines for dealing with the mc_env

source: mc_environment_types.F
Loading...

public Types:

mc_environment_type
...
mc_environment_p_type
...

public Subroutines/Functions:

provides a method for getting the various structures attached to an mc_env
SUBROUTINE
mc_env_create (mc_env)
creates and initializes an mc_env
SUBROUTINE
mc_env_release (mc_env)
releases the given mc env
provides a method for attaching various structures to an mc_env

public Types:

TYPE :: mc_environment_p_type

...


POINTER :: mc_env ...

TYPE :: mc_environment_type

...


INTEGER
:: id_nr ...
INTEGER
:: ref_count ...
INTEGER
:: in_use ...
POINTER :: mc_par ...
POINTER :: force_env ...

SUBROUTINEget_mc_env(mc_env, mc_par, force_env)

provides a method for getting the various structures attached to an mc_env

Arguments:
POINTER
:: mc_env the mc_environment you want to get information on
OPTIONAL, POINTER
:: mc_par the mc parameters you want to point to the parameters associated with this mc_env
OPTIONAL, POINTER
:: force_env the force environment type you want to point to the force environment associated with this mc_env

SUBROUTINEmc_env_create(mc_env)

creates and initializes an mc_env

Arguments:
POINTER
:: mc_env the mc_environment you want to create

SUBROUTINEmc_env_release(mc_env)

releases the given mc env

Arguments:
POINTER
:: mc_env the mc environment to release

SUBROUTINEset_mc_env(mc_env, mc_par, force_env)

provides a method for attaching various structures to an mc_env

Arguments:
POINTER
:: mc_env the mc_environment you want to change
OPTIONAL, POINTER
:: mc_par the mc parameters you want to associate with this mc_env
OPTIONAL, POINTER
:: force_env the force environment type you want to associate with this mc_env