CAMP 1.0.0
Chemistry Across Multiple Phases
Data Types | Functions/Subroutines
camp_camp_state Module Reference

The camp_state_t structure and associated subroutines. More...

Data Types

type  camp_state_ptr
 Pointer type for building arrays. More...
 
interface  camp_state_t
 Model state. More...
 

Functions/Subroutines

type(camp_state_t) function, pointer constructor_one_cell (env_state)
 Constructor for camp_state_t.
 
type(camp_state_t) function, pointer constructor_multi_cell (num_cells, env_states)
 Constructor for camp_state_t.
 
subroutine update_env_state (this)
 Update the environmental state array.
 
elemental subroutine finalize (this)
 Finalize the state.
 
elemental subroutine dereference (this)
 Deference a pointer to a camp state.
 
elemental subroutine ptr_finalize (this)
 Finalize a pointer to a camp state.
 

Detailed Description

The camp_state_t structure and associated subroutines.

Function/Subroutine Documentation

◆ constructor_multi_cell()

type(camp_state_t) function, pointer camp_camp_state::constructor_multi_cell ( integer(kind=i_kind), intent(in)  num_cells,
type(env_state_ptr), dimension(:), intent(in), optional, target  env_states 
)
private

Constructor for camp_state_t.

Returns
New model state
Parameters
[in]num_cellsNumber of grid cells to solve simultaneously
[in]env_statesEnvironmental state

Definition at line 98 of file camp_state.F90.

◆ constructor_one_cell()

type(camp_state_t) function, pointer camp_camp_state::constructor_one_cell ( type(env_state_t), intent(in), optional, target  env_state)

Constructor for camp_state_t.

Returns
New model state
Parameters
[in]env_stateEnvironmental state

Definition at line 71 of file camp_state.F90.

◆ dereference()

elemental subroutine camp_camp_state::dereference ( class(camp_state_ptr), intent(inout)  this)
private

Deference a pointer to a camp state.

Parameters
[in,out]thisPointer to the camp state

Definition at line 170 of file camp_state.F90.

◆ finalize()

elemental subroutine camp_camp_state::finalize ( type(camp_state_t), intent(inout)  this)
private

Finalize the state.

Parameters
[in,out]thisCAMP model state

Definition at line 149 of file camp_state.F90.

Here is the caller graph for this function:

◆ ptr_finalize()

elemental subroutine camp_camp_state::ptr_finalize ( type(camp_state_ptr), intent(inout)  this)
private

Finalize a pointer to a camp state.

Parameters
[in,out]thisPointer to the camp state

Definition at line 182 of file camp_state.F90.

Here is the caller graph for this function:

◆ update_env_state()

subroutine camp_camp_state::update_env_state ( class(camp_state_t), intent(inout)  this)
private

Update the environmental state array.

Parameters
[in,out]thisModel state

Definition at line 131 of file camp_state.F90.