mc_environment_types Module Reference

contains the subroutines for dealing with the mc_env More...

Functions/Subroutines
subroutine, public	mc_env_create (mc_env)
	creates and initializes an mc_env More...
subroutine, public	set_mc_env (mc_env, mc_par, force_env)
	provides a method for attaching various structures to an mc_env More...
subroutine, public	get_mc_env (mc_env, mc_par, force_env)
	provides a method for getting the various structures attached to an mc_env More...
subroutine, public	mc_env_release (mc_env)
	releases the given mc env More...

Detailed Description

contains the subroutines for dealing with the mc_env

Author

MJM Oct. 15-2003

Function/Subroutine Documentation

mc_env_create()

subroutine, public mc_environment_types::mc_env_create

(

type(mc_environment_type), intent(out)

mc_env

)

creates and initializes an mc_env

Parameters

mc_env

the mc_environment you want to create

Suitable for parallel use.

Author

MJM

Definition at line 51 of file mc_environment_types.F.

Here is the caller graph for this function:

set_mc_env()

subroutine, public mc_environment_types::set_mc_env	(	type(mc_environment_type), intent(inout)	mc_env,
		type(mc_simpar_type), optional, pointer	mc_par,
		type(force_env_type), optional, pointer	force_env
	)

provides a method for attaching various structures to an mc_env

Parameters

mc_env	the mc_environment you want to change
mc_par	the mc parameters you want to associate with this mc_env
force_env	the force environment type you want to associate with this mc_env

Suitable for parallel.

Author

MJM

Definition at line 69 of file mc_environment_types.F.

Here is the caller graph for this function:

get_mc_env()

subroutine, public mc_environment_types::get_mc_env	(	type(mc_environment_type), intent(in)	mc_env,
		type(mc_simpar_type), optional, pointer	mc_par,
		type(force_env_type), optional, pointer	force_env
	)

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

Parameters

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

Suitable for parallel.

Author

MJM

Definition at line 94 of file mc_environment_types.F.

Here is the caller graph for this function:

mc_env_release()

subroutine, public mc_environment_types::mc_env_release

(

type(mc_environment_type), intent(inout)

mc_env

)

releases the given mc env

Parameters

mc_env

the mc environment to release

Author

MJM

Note

see doc/ReferenceCounting.html

Definition at line 112 of file mc_environment_types.F.

Here is the caller graph for this function: