CAMP 1.0.0
Chemistry Across Multiple Phases
Public Member Functions | Public Attributes | Private Member Functions | List of all members
camp_camp_solver_data::camp_solver_data_t Interface Reference

Solver data. More...

Public Member Functions

procedure initialize
 Initialize the solver. More...
 
procedure update_sub_model_data
 Update sub-model data. More...
 
procedure update_rxn_data
 Update reactions data. More...
 
procedure update_aero_rep_data
 Update aerosol representation data. More...
 
procedure solve
 Integrate over a given time step. More...
 
procedure is_solver_available
 Checks whether a solver is available. More...
 
procedure print => do_print
 Print the solver data. More...
 
final finalize
 Finalize the solver data. More...
 

Public Attributes

type(c_ptr), public solver_c_ptr
 C Solver object. More...
 
real(kind=dp), public rel_tol = CAMP_SOLVER_DEFAULT_REL_TOL
 Relative tolerance for the integration. More...
 
integer(kind=i_kind), public max_steps = CAMP_SOLVER_DEFAULT_MAX_STEPS
 Maximum number of timesteps. More...
 
integer(kind=i_kind), public max_conv_fails = CAMP_SOLVER_DEFAULT_MAX_CONV_FAILS
 Maximum number of convergence failures. More...
 
logical initialized = .false.
 Flag indicating whether the solver was intialized. More...
 

Private Member Functions

procedure, private reset_timers
 Reset the solver function timers. More...
 
procedure, private get_solver_stats
 Get the solver statistics from the last run. More...
 

Detailed Description

Solver data.

Acts as the interface between the camp-chem module and the solver. Instances of the type hold a pointer to a solver c object and provide functions to initialize the solver with model data and run the solver over a specified time step.

Definition at line 371 of file camp_solver_data.F90.

Member Function/Subroutine Documentation

◆ finalize()

final camp_camp_solver_data::camp_solver_data_t::finalize
final

Finalize the solver data.

Definition at line 404 of file camp_solver_data.F90.

Here is the call graph for this function:

◆ get_solver_stats()

procedure, private camp_camp_solver_data::camp_solver_data_t::get_solver_stats
private

Get the solver statistics from the last run.

Definition at line 398 of file camp_solver_data.F90.

◆ initialize()

procedure camp_camp_solver_data::camp_solver_data_t::initialize

Initialize the solver.

Definition at line 386 of file camp_solver_data.F90.

◆ is_solver_available()

procedure camp_camp_solver_data::camp_solver_data_t::is_solver_available

Checks whether a solver is available.

Definition at line 400 of file camp_solver_data.F90.

◆ print()

procedure camp_camp_solver_data::camp_solver_data_t::print

Print the solver data.

Definition at line 402 of file camp_solver_data.F90.

◆ reset_timers()

procedure, private camp_camp_solver_data::camp_solver_data_t::reset_timers
private

Reset the solver function timers.

Definition at line 396 of file camp_solver_data.F90.

◆ solve()

procedure camp_camp_solver_data::camp_solver_data_t::solve

Integrate over a given time step.

Definition at line 394 of file camp_solver_data.F90.

◆ update_aero_rep_data()

procedure camp_camp_solver_data::camp_solver_data_t::update_aero_rep_data

Update aerosol representation data.

Definition at line 392 of file camp_solver_data.F90.

◆ update_rxn_data()

procedure camp_camp_solver_data::camp_solver_data_t::update_rxn_data

Update reactions data.

Definition at line 390 of file camp_solver_data.F90.

◆ update_sub_model_data()

procedure camp_camp_solver_data::camp_solver_data_t::update_sub_model_data

Update sub-model data.

Definition at line 388 of file camp_solver_data.F90.

Member Data Documentation

◆ initialized

logical camp_camp_solver_data::camp_solver_data_t::initialized = .false.

Flag indicating whether the solver was intialized.

Definition at line 383 of file camp_solver_data.F90.

◆ max_conv_fails

integer(kind=i_kind), public camp_camp_solver_data::camp_solver_data_t::max_conv_fails = CAMP_SOLVER_DEFAULT_MAX_CONV_FAILS

Maximum number of convergence failures.

Definition at line 380 of file camp_solver_data.F90.

◆ max_steps

integer(kind=i_kind), public camp_camp_solver_data::camp_solver_data_t::max_steps = CAMP_SOLVER_DEFAULT_MAX_STEPS

Maximum number of timesteps.

Definition at line 378 of file camp_solver_data.F90.

◆ rel_tol

real(kind=dp), public camp_camp_solver_data::camp_solver_data_t::rel_tol = CAMP_SOLVER_DEFAULT_REL_TOL

Relative tolerance for the integration.

Definition at line 376 of file camp_solver_data.F90.

◆ solver_c_ptr

type(c_ptr), public camp_camp_solver_data::camp_solver_data_t::solver_c_ptr

C Solver object.

Definition at line 374 of file camp_solver_data.F90.


The documentation for this interface was generated from the following file: