Wet deposition reaction solver functions. More...

Include dependency graph for rxn_wet_deposition.c:

Macros
#define	TEMPERATURE_K_ env_data[0]

#define	PRESSURE_PA_ env_data[1]

#define	RXN_ID_ (int_data[0])

#define	NUM_SPEC_ (int_data[1])

#define	SCALING_ float_data[0]

#define	RATE_CONSTANT_ (rxn_env_data[0])

#define	BASE_RATE_ (rxn_env_data[1])

#define	NUM_INT_PROP_ 2

#define	NUM_FLOAT_PROP_ 1

#define	NUM_ENV_PARAM_ 2

#define	REACT_(s) (int_data[NUM_INT_PROP_ + s] - 1)

#define	DERIV_ID_(s) int_data[NUM_INT_PROP_ + NUM_SPEC_ + s]

#define	JAC_ID_(s) int_data[NUM_INT_PROP_ + 2 * NUM_SPEC_ + s]

Functions
void	rxn_wet_deposition_get_used_jac_elem (int rxn_int_data, double rxn_float_data, Jacobian *jac)
	Flag Jacobian elements used by this reaction.

void	rxn_wet_deposition_update_ids (ModelData model_data, int deriv_ids, Jacobian jac, int rxn_int_data, double rxn_float_data)
	Update the time derivative and Jacbobian array indices.

bool	rxn_wet_deposition_update_data (void update_data, int rxn_int_data, double rxn_float_data, double rxn_env_data)
	Update reaction data.

void	rxn_wet_deposition_update_env_state (ModelData model_data, int rxn_int_data, double rxn_float_data, double rxn_env_data)
	Update reaction data for new environmental conditions.

void	rxn_wet_deposition_calc_deriv_contrib (ModelData model_data, TimeDerivative time_deriv, int rxn_int_data, double rxn_float_data, double rxn_env_data, realtype time_step)
	Calculate contributions to the time derivative \(f(t,y)\) from this reaction.

void	rxn_wet_deposition_calc_jac_contrib (ModelData model_data, Jacobian jac, int rxn_int_data, double rxn_float_data, double rxn_env_data, realtype time_step)
	Calculate contributions to the Jacobian from this reaction.

void	rxn_wet_deposition_print (int rxn_int_data, double rxn_float_data)
	Print the reaction parameters.

void *	rxn_wet_deposition_create_rate_update_data ()
	Create update data for new wet deposition rates.

void	rxn_wet_deposition_set_rate_update_data (void *update_data, int rxn_id, double base_rate)
	Set rate update data.

Detailed Description

Wet deposition reaction solver functions.

Definition in file rxn_wet_deposition.c.

Macro Definition Documentation

◆ BASE_RATE_

#define BASE_RATE_ (rxn_env_data[1])

Definition at line 24 of file rxn_wet_deposition.c.

◆ DERIV_ID_

#define DERIV_ID_ ( s ) int_data[NUM_INT_PROP_ + NUM_SPEC_ + s]

Definition at line 29 of file rxn_wet_deposition.c.

◆ JAC_ID_

#define JAC_ID_ ( s ) int_data[NUM_INT_PROP_ + 2 * NUM_SPEC_ + s]

Definition at line 30 of file rxn_wet_deposition.c.

◆ NUM_ENV_PARAM_

#define NUM_ENV_PARAM_ 2

Definition at line 27 of file rxn_wet_deposition.c.

◆ NUM_FLOAT_PROP_

#define NUM_FLOAT_PROP_ 1

Definition at line 26 of file rxn_wet_deposition.c.

◆ NUM_INT_PROP_

#define NUM_INT_PROP_ 2

Definition at line 25 of file rxn_wet_deposition.c.

◆ NUM_SPEC_

#define NUM_SPEC_ (int_data[1])

Definition at line 21 of file rxn_wet_deposition.c.

◆ PRESSURE_PA_

#define PRESSURE_PA_ env_data[1]

Definition at line 18 of file rxn_wet_deposition.c.

◆ RATE_CONSTANT_

#define RATE_CONSTANT_ (rxn_env_data[0])

Definition at line 23 of file rxn_wet_deposition.c.

◆ REACT_

#define REACT_ ( s ) (int_data[NUM_INT_PROP_ + s] - 1)

Definition at line 28 of file rxn_wet_deposition.c.

◆ RXN_ID_

#define RXN_ID_ (int_data[0])

Definition at line 20 of file rxn_wet_deposition.c.

◆ SCALING_

#define SCALING_ float_data[0]

Definition at line 22 of file rxn_wet_deposition.c.

◆ TEMPERATURE_K_

#define TEMPERATURE_K_ env_data[0]

Definition at line 17 of file rxn_wet_deposition.c.

Function Documentation

◆ rxn_wet_deposition_calc_deriv_contrib()

void rxn_wet_deposition_calc_deriv_contrib	(	ModelData *	model_data,
		TimeDerivative	time_deriv,
		int *	rxn_int_data,
		double *	rxn_float_data,
		double *	rxn_env_data,
		realtype	time_step
	)

Calculate contributions to the time derivative \(f(t,y)\) from this reaction.

Parameters

model_data	Pointer to the model data, including the state array
time_deriv	TimeDerivative object
rxn_int_data	Pointer to the reaction integer data
rxn_float_data	Pointer to the reaction floating-point data
rxn_env_data	Pointer to the environment-dependent parameters
time_step	Current time step being computed (s)

Definition at line 149 of file rxn_wet_deposition.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rxn_wet_deposition_calc_jac_contrib()

void rxn_wet_deposition_calc_jac_contrib	(	ModelData *	model_data,
		Jacobian	jac,
		int *	rxn_int_data,
		double *	rxn_float_data,
		double *	rxn_env_data,
		realtype	time_step
	)

Calculate contributions to the Jacobian from this reaction.

Parameters

model_data	Pointer to the model data
jac	Reaction Jacobian
rxn_int_data	Pointer to the reaction integer data
rxn_float_data	Pointer to the reaction floating-point data
rxn_env_data	Pointer to the environment-dependent parameters
time_step	Current time step being calculated (s)

Definition at line 179 of file rxn_wet_deposition.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rxn_wet_deposition_create_rate_update_data()

void * rxn_wet_deposition_create_rate_update_data ( )

Create update data for new wet deposition rates.

Returns: Pointer to a new rate update data object

Definition at line 218 of file rxn_wet_deposition.c.

◆ rxn_wet_deposition_get_used_jac_elem()

void rxn_wet_deposition_get_used_jac_elem	(	int *	rxn_int_data,
		double *	rxn_float_data,
		Jacobian *	jac
	)

Flag Jacobian elements used by this reaction.

Parameters

rxn_int_data	Pointer to the reaction integer data
rxn_float_data	Pointer to the reaction floating-point data
jac	Jacobian

Definition at line 38 of file rxn_wet_deposition.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rxn_wet_deposition_print()

void rxn_wet_deposition_print	(	int *	rxn_int_data,
		double *	rxn_float_data
	)

Print the reaction parameters.

Parameters

rxn_int_data	Pointer to the reaction integer data
rxn_float_data	Pointer to the reaction floating-point data

Definition at line 205 of file rxn_wet_deposition.c.

Here is the caller graph for this function:

◆ rxn_wet_deposition_set_rate_update_data()

void rxn_wet_deposition_set_rate_update_data	(	void *	update_data,
		int	rxn_id,
		double	base_rate
	)

Set rate update data.

Parameters

update_data	Pointer to an allocated rate update data object
rxn_id	Id of wet deposition reactions to update
base_rate	New pre-scaling wet deposition rate

Definition at line 233 of file rxn_wet_deposition.c.

◆ rxn_wet_deposition_update_data()

bool rxn_wet_deposition_update_data	(	void *	update_data,
		int *	rxn_int_data,
		double *	rxn_float_data,
		double *	rxn_env_data
	)

Update reaction data.

Wet deposition reactions can have their base (pre-scaling) rate constants updated from the host model based on the calculations of an external module. The structure of the update data is:

int rxn_id (Id of one or more wet deposition reactions set by the host model using the camp_rxn_wet_deposition::rxn_wet_deposition_t::set_rxn_id function prior to initializing the solver.)
double rate_const (New pre-scaling rate constant.)

Parameters

update_data	Pointer to the updated reaction data
rxn_int_data	Pointer to the reaction integer data
rxn_float_data	Pointer to the reaction floating-point data
rxn_env_data	Pointer to the environment-dependent data

Returns: Flag indicating whether this is the reaction to update

Definition at line 95 of file rxn_wet_deposition.c.

Here is the caller graph for this function:

◆ rxn_wet_deposition_update_env_state()

void rxn_wet_deposition_update_env_state	(	ModelData *	model_data,
		int *	rxn_int_data,
		double *	rxn_float_data,
		double *	rxn_env_data
	)

Update reaction data for new environmental conditions.

For wet deposition reactions this only involves recalculating the rate constant.

Parameters

model_data	Pointer to the model data
rxn_int_data	Pointer to the reaction integer data
rxn_float_data	Pointer to the reaction floating-point data
rxn_env_data	Pointer to the environment-dependent parameters

Definition at line 124 of file rxn_wet_deposition.c.

Here is the caller graph for this function:

◆ rxn_wet_deposition_update_ids()

void rxn_wet_deposition_update_ids	(	ModelData *	model_data,
		int *	deriv_ids,
		Jacobian	jac,
		int *	rxn_int_data,
		double *	rxn_float_data
	)

Update the time derivative and Jacbobian array indices.

Parameters

model_data	Pointer to the model data
deriv_ids	Id of each state variable in the derivative array
jac	Jacobian
rxn_int_data	Pointer to the reaction integer data
rxn_float_data	Pointer to the reaction floating-point data

Definition at line 59 of file rxn_wet_deposition.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ BASE_RATE_

◆ DERIV_ID_

◆ JAC_ID_

◆ NUM_ENV_PARAM_

◆ NUM_FLOAT_PROP_

◆ NUM_INT_PROP_

◆ NUM_SPEC_

◆ PRESSURE_PA_

◆ RATE_CONSTANT_

◆ REACT_

◆ RXN_ID_

◆ SCALING_

◆ TEMPERATURE_K_

Function Documentation

◆ rxn_wet_deposition_calc_deriv_contrib()

◆ rxn_wet_deposition_calc_jac_contrib()

◆ rxn_wet_deposition_create_rate_update_data()

◆ rxn_wet_deposition_get_used_jac_elem()

◆ rxn_wet_deposition_print()

◆ rxn_wet_deposition_set_rate_update_data()

◆ rxn_wet_deposition_update_data()

◆ rxn_wet_deposition_update_env_state()

◆ rxn_wet_deposition_update_ids()