Header file for aerosol representations functions. More...

Include dependency graph for aero_reps.h:

This graph shows which files directly or indirectly include this file:

Functions
int	aero_rep_modal_binned_mass_get_used_jac_elem (ModelData model_data, int aero_phase_idx, int aero_rep_int_data, double aero_rep_float_data, bool jac_struct)
	Flag Jacobian elements used in calcualtions of mass and volume.

void	aero_rep_modal_binned_mass_get_dependencies (int aero_rep_int_data, double aero_rep_float_data, bool *state_flags)
	Flag elements on the state array used by this aerosol representation.

void	aero_rep_modal_binned_mass_update_env_state (ModelData model_data, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Update aerosol representation data for new environmental conditions.

void	aero_rep_modal_binned_mass_update_state (ModelData model_data, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Update aerosol representation data for a new state.

void	aero_rep_modal_binned_mass_get_effective_radius__m (ModelData model_data, int aero_phase_idx, double radius, double partial_deriv, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the effective particle radius \(r_{eff}\) (m)

void	aero_rep_modal_binned_mass_get_number_conc__n_m3 (ModelData model_data, int aero_phase_idx, double number_conc, double partial_deriv, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the particle number concentration \(n\) ( \(\mbox{\si{\#\per\cubic\metre}}\))

void	aero_rep_modal_binned_mass_get_aero_conc_type (int aero_phase_idx, int aero_conc_type, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the type of aerosol concentration used.

void	aero_rep_modal_binned_mass_get_aero_phase_mass__kg_m3 (ModelData model_data, int aero_phase_idx, double aero_phase_mass, double partial_deriv, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the total mass in an aerosol phase \(m\) ( \(\mbox{\si{\kilogram\per\cubic\metre}}\))

void	aero_rep_modal_binned_mass_get_aero_phase_avg_MW__kg_mol (ModelData model_data, int aero_phase_idx, double aero_phase_avg_MW, double partial_deriv, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the average molecular weight in an aerosol phase \(m\) ( \(\mbox{\si{\kilogram\per\mole}}\))

bool	aero_rep_modal_binned_mass_update_data (void update_data, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Update the aerosol representation data.

void	aero_rep_modal_binned_mass_print (int aero_rep_int_data, double aero_rep_float_data)
	Print the mass-only modal/binned reaction parameters.

void *	aero_rep_modal_binned_mass_create_gmd_update_data ()
	Create update data for new GMD.

void	aero_rep_modal_binned_mass_set_gmd_update_data (void *update_data, int aero_rep_id, int section_id, double gmd)
	Set GMD update data.

void *	aero_rep_modal_binned_mass_create_gsd_update_data ()
	Create update data for new GSD.

void	aero_rep_modal_binned_mass_set_gsd_update_data (void *update_data, int aero_rep_id, int section_id, double gsd)
	Set GSD update data.

int	aero_rep_single_particle_get_used_jac_elem (ModelData model_data, int aero_phase_idx, int aero_rep_int_data, double aero_rep_float_data, bool jac_struct)
	Flag Jacobian elements used in calcualtions of mass and volume.

void	aero_rep_single_particle_get_dependencies (int aero_rep_int_data, double aero_rep_float_data, bool *state_flags)
	Flag elements on the state array used by this aerosol representation.

void	aero_rep_single_particle_update_env_state (ModelData model_data, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Update aerosol representation data for new environmental conditions.

void	aero_rep_single_particle_update_state (ModelData model_data, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Update aerosol representation data for a new state.

void	aero_rep_single_particle_get_effective_radius__m (ModelData model_data, int aero_phase_idx, double radius, double partial_deriv, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the effective particle radius \(r_{eff}\) (m)

void	aero_rep_single_particle_get_number_conc__n_m3 (ModelData model_data, int aero_phase_idx, double number_conc, double partial_deriv, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the particle number concentration \(n\) ( \(\mbox{\si{\#\per\cubic\metre}}\))

void	aero_rep_single_particle_get_aero_conc_type (int aero_phase_idx, int aero_conc_type, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the type of aerosol concentration used.

void	aero_rep_single_particle_get_aero_phase_mass__kg_m3 (ModelData model_data, int aero_phase_idx, double aero_phase_mass, double partial_deriv, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the total mass in an aerosol phase \(m\) ( \(\mbox{\si{\kilogram\per\cubic\metre}}\))

void	aero_rep_single_particle_get_aero_phase_avg_MW__kg_mol (ModelData model_data, int aero_phase_idx, double aero_phase_avg_MW, double partial_deriv, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Get the average molecular weight in an aerosol phase \(m\) ( \(\mbox{\si{\kilo\gram\per\mol}}\))

bool	aero_rep_single_particle_update_data (void update_data, int aero_rep_int_data, double aero_rep_float_data, double aero_rep_env_data)
	Update aerosol representation data.

void	aero_rep_single_particle_print (int aero_rep_int_data, double aero_rep_float_data)
	Print the Single Particle reaction parameters.

void *	aero_rep_single_particle_create_number_update_data ()
	Create update data for new particle number.

void	aero_rep_single_particle_set_number_update_data__n_m3 (void *update_data, int aero_rep_id, int particle_id, double number_conc)
	Set number update data (#/m3)

Detailed Description

Header file for aerosol representations functions.

Definition in file aero_reps.h.

Function Documentation

◆ aero_rep_modal_binned_mass_create_gmd_update_data()

void * aero_rep_modal_binned_mass_create_gmd_update_data ( )

Create update data for new GMD.

Returns: Pointer to a new GMD update data object

Definition at line 677 of file aero_rep_modal_binned_mass.c.

◆ aero_rep_modal_binned_mass_create_gsd_update_data()

void * aero_rep_modal_binned_mass_create_gsd_update_data ( )

Create update data for new GSD.

Returns: Pointer to a new GSD update data object

Definition at line 711 of file aero_rep_modal_binned_mass.c.

◆ aero_rep_modal_binned_mass_get_aero_conc_type()

void aero_rep_modal_binned_mass_get_aero_conc_type	(	int	aero_phase_idx,
		int *	aero_conc_type,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the type of aerosol concentration used.

Modal mass concentrations are per-mode or per-bin.

Parameters

aero_phase_idx	Index of the aerosol phase within the representation
aero_conc_type	Pointer to int that will hold the concentration type code
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 434 of file aero_rep_modal_binned_mass.c.

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_get_aero_phase_avg_MW__kg_mol()

void aero_rep_modal_binned_mass_get_aero_phase_avg_MW__kg_mol	(	ModelData *	model_data,
		int	aero_phase_idx,
		double *	aero_phase_avg_MW,
		double *	partial_deriv,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the average molecular weight in an aerosol phase \(m\) ( \(\mbox{\si{\kilogram\per\mole}}\))

Parameters

model_data	Pointer to the model data, including the state array
aero_phase_idx	Index of the aerosol phase within the representation
aero_phase_avg_MW	Average molecular weight in the aerosol phase ( \(\mbox{\si{\kilogram\per\mole}}\))
partial_deriv	\(\frac{\partial m}{\partial y}\) where \(y\) are the species on the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 525 of file aero_rep_modal_binned_mass.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_get_aero_phase_mass__kg_m3()

void aero_rep_modal_binned_mass_get_aero_phase_mass__kg_m3	(	ModelData *	model_data,
		int	aero_phase_idx,
		double *	aero_phase_mass,
		double *	partial_deriv,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the total mass in an aerosol phase \(m\) ( \(\mbox{\si{\kilogram\per\cubic\metre}}\))

Parameters

model_data	Pointer to the model data, including the state array
aero_phase_idx	Index of the aerosol phase within the representation
aero_phase_mass	Total mass in the aerosol phase, \(m\) ( \(\mbox{\si{\kilogram\per\cubic\metre}}\))
partial_deriv	\(\frac{\partial m}{\partial y}\) where \(y\) are the species on the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 462 of file aero_rep_modal_binned_mass.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_get_dependencies()

void aero_rep_modal_binned_mass_get_dependencies	(	int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		bool *	state_flags
	)

Flag elements on the state array used by this aerosol representation.

The modal mass aerosol representation functions do not use state array values

Parameters

aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
state_flags	Array of flags indicating state array elements used

Definition at line 139 of file aero_rep_modal_binned_mass.c.

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_get_effective_radius__m()

void aero_rep_modal_binned_mass_get_effective_radius__m	(	ModelData *	model_data,
		int	aero_phase_idx,
		double *	radius,
		double *	partial_deriv,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the effective particle radius \(r_{eff}\) (m)

The modal mass effective radius is calculated for a log-normal distribution where the geometric mean diameter ( \(\tilde{D}_n\)) and geometric standard deviation ( \(\sigma_g\)) are set by the aerosol model prior to solving the chemistry. Thus, all \(\frac{\partial r_{eff}}{\partial y}\) are zero. The effective radius is calculated according to the equation given in Table 1 of Zender [Zender2002] :

\[ \tilde{\sigma_g} \equiv ln( \sigma_g ) \]

\[ D_s = D_{eff} = \tilde{D_n} e^{5 \tilde{\sigma}_g^2 / 2} \]

\[ r_{eff} = \frac{D_{eff}}{2} \]

For bins, \(r_{eff}\) is assumed to be the bin radius.

Parameters

model_data	Pointer to the model data, including the state array
aero_phase_idx	Index of the aerosol phase within the representation
radius	Effective particle radius (m)
partial_deriv	\(\frac{\partial r_{eff}}{\partial y}\) where \(y\) are species on the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 300 of file aero_rep_modal_binned_mass.c.

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_get_number_conc__n_m3()

void aero_rep_modal_binned_mass_get_number_conc__n_m3	(	ModelData *	model_data,
		int	aero_phase_idx,
		double *	number_conc,
		double *	partial_deriv,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the particle number concentration \(n\) ( \(\mbox{\si{\#\per\cubic\metre}}\))

The modal mass number concentration is calculated for a log-normal distribution where the geometric mean diameter ( \(\tilde{D}_n\)) and geometric standard deviation ( \(\tilde{\sigma}_g\)) are set by the aerosol model prior to solving the chemistry. The number concentration is calculated according to the equation given in Table 1 of Zender [Zender2002] :

\[ n = N_0 = \frac{6V_0}{\pi}\tilde{D}_n^{-3}e^{-9 ln(\tilde{\sigma}_g)^2/2} \]

\[ V_0 = \sum_i{\frac{m_i}{\rho_i}} \]

where \(\rho_i\) and \(m_i\) are the density and total mass of species \(i\) in the specified mode.

The binned number concentration is calculated according to:

\[ n = V_0 / V_p \]

\[ V_p = \frac{4}{3}\pi r^{3} \]

where \(r\) is the radius of the size bin and \(V_0\) is defined as above.

Parameters

model_data	Pointer to the model data, including the state array
aero_phase_idx	Index of the aerosol phase within the representation
number_conc	Particle number concentration, \(n\) ( \(\mbox{\si{\#\per\cubic\centi\metre}}\))
partial_deriv	\(\frac{\partial n}{\partial y}\) where \(y\) are the species on the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 368 of file aero_rep_modal_binned_mass.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_get_used_jac_elem()

int aero_rep_modal_binned_mass_get_used_jac_elem	(	ModelData *	model_data,
		int	aero_phase_idx,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		bool *	jac_struct
	)

Flag Jacobian elements used in calcualtions of mass and volume.

Parameters

model_data	Pointer to the model data
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_phase_idx	Index of the aerosol phase to find elements for
jac_struct	1D array of flags indicating potentially non-zero Jacobian elements. (The dependent variable should have been chosen by the calling function.)

Returns: Number of Jacobian elements flagged

Definition at line 95 of file aero_rep_modal_binned_mass.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_print()

void aero_rep_modal_binned_mass_print	(	int *	aero_rep_int_data,
		double *	aero_rep_float_data
	)

Print the mass-only modal/binned reaction parameters.

Parameters

aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data

Definition at line 663 of file aero_rep_modal_binned_mass.c.

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_set_gmd_update_data()

void aero_rep_modal_binned_mass_set_gmd_update_data	(	void *	update_data,
		int	aero_rep_id,
		int	section_id,
		double	gmd
	)

Set GMD update data.

Parameters

update_data	Pointer to an allocated GMD update data object
aero_rep_id	Id of the aerosol representation(s) to update
section_id	Id of the mode to update
gmd	New mode GMD (m)

Definition at line 693 of file aero_rep_modal_binned_mass.c.

◆ aero_rep_modal_binned_mass_set_gsd_update_data()

void aero_rep_modal_binned_mass_set_gsd_update_data	(	void *	update_data,
		int	aero_rep_id,
		int	section_id,
		double	gsd
	)

Set GSD update data.

Parameters

update_data	Pointer to an allocated GSD update data object
aero_rep_id	Id of the aerosol representation(s) to update
section_id	Id of the mode to update
gsd	New mode GSD (unitless)

Definition at line 727 of file aero_rep_modal_binned_mass.c.

◆ aero_rep_modal_binned_mass_update_data()

bool aero_rep_modal_binned_mass_update_data	(	void *	update_data,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Update the aerosol representation data.

The model mass aerosol representation update data is structured as follows:

int aero_rep_id (Id of one or more aerosol representations set by the host model using the camp_aero_rep_modal_binned_mass::aero_rep_modal_binned_mass_t::set_id function prior to initializing the solver.)
int update_type (Type of update to perform. Can be UPDATE_GMD or UPDATE_GSD.)
int section_id (Index of the mode to update.)
double new_value (Either the new GMD (m) or the new GSD (unitless).)

Parameters

update_data	Pointer to the updated aerosol representation data
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Returns: Flag indicating whether this is the aerosol representation to update

Recalculate the effective radius [m]

Equation based on [Zender2002] Table 1 effective diameter \((D_s, D_{eff}\)) equations:

\[ \tilde{\sigma_g} \equiv ln( \sigma_g ) \]

\[ D_s = D_{eff} = \tilde{D_n} e^{5 \tilde{\sigma}_g^2 / 2} \]

\[ r_{eff} = \frac{D_{eff}}{2} \]

where \(\tilde{D_n}\) is the geometric mean diameter [m], \(\sigma_g\) is the geometric standard deviation [unitless], and \(r_{eff}\) is the effective radius [m].

Definition at line 594 of file aero_rep_modal_binned_mass.c.

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_update_env_state()

void aero_rep_modal_binned_mass_update_env_state	(	ModelData *	model_data,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Update aerosol representation data for new environmental conditions.

The modal mass aerosol representation is not updated for new environmental conditions

Parameters

model_data	Pointer to the model data
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 160 of file aero_rep_modal_binned_mass.c.

Here is the caller graph for this function:

◆ aero_rep_modal_binned_mass_update_state()

void aero_rep_modal_binned_mass_update_state	(	ModelData *	model_data,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Update aerosol representation data for a new state.

The modal mass aerosol representation recalculates effective radius and number concentration for each new state.

Parameters

model_data	Pointer to the model data, including the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 183 of file aero_rep_modal_binned_mass.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_single_particle_create_number_update_data()

void * aero_rep_single_particle_create_number_update_data ( )

Create update data for new particle number.

Returns: Pointer to a new number update data object

Definition at line 442 of file aero_rep_single_particle.c.

◆ aero_rep_single_particle_get_aero_conc_type()

void aero_rep_single_particle_get_aero_conc_type	(	int	aero_phase_idx,
		int *	aero_conc_type,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the type of aerosol concentration used.

Single particle concentrations are per-particle.

Parameters

aero_phase_idx	Index of the aerosol phase within the representation
aero_conc_type	Pointer to int that will hold the concentration type code (0 = per particle mass concentrations; 1 = total particle mass concentrations)
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 250 of file aero_rep_single_particle.c.

Here is the caller graph for this function:

◆ aero_rep_single_particle_get_aero_phase_avg_MW__kg_mol()

void aero_rep_single_particle_get_aero_phase_avg_MW__kg_mol	(	ModelData *	model_data,
		int	aero_phase_idx,
		double *	aero_phase_avg_MW,
		double *	partial_deriv,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the average molecular weight in an aerosol phase \(m\) ( \(\mbox{\si{\kilo\gram\per\mol}}\))

The single particle mass is set for each new state as the sum of the masses of the aerosol phases that compose the particle

Parameters

model_data	Pointer to the model data, including the state array
aero_phase_idx	Index of the aerosol phase within the representation
aero_phase_avg_MW	Average molecular weight in the aerosol phase ( \(\mbox{\si{\kilogram\per\mole}}\))
partial_deriv	\(\frac{\partial m}{\partial y}\) where \(y\) are the species on the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 331 of file aero_rep_single_particle.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_single_particle_get_aero_phase_mass__kg_m3()

void aero_rep_single_particle_get_aero_phase_mass__kg_m3	(	ModelData *	model_data,
		int	aero_phase_idx,
		double *	aero_phase_mass,
		double *	partial_deriv,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the total mass in an aerosol phase \(m\) ( \(\mbox{\si{\kilogram\per\cubic\metre}}\))

The single particle mass is set for each new state as the sum of the masses of the aerosol phases that compose the particle

Parameters

model_data	Pointer to the model data, including the state array
aero_phase_idx	Index of the aerosol phase within the representation
aero_phase_mass	Total mass in the aerosol phase, \(m\) ( \(\mbox{\si{\kilogram\per\cubic\metre}}\))
partial_deriv	\(\frac{\partial m}{\partial y}\) where \(y\) are the species on the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 282 of file aero_rep_single_particle.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_single_particle_get_dependencies()

void aero_rep_single_particle_get_dependencies	(	int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		bool *	state_flags
	)

Flag elements on the state array used by this aerosol representation.

The single particle aerosol representation functions do not use state array values

Parameters

aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
state_flags	Array of flags indicating state array elements used

Definition at line 86 of file aero_rep_single_particle.c.

Here is the caller graph for this function:

◆ aero_rep_single_particle_get_effective_radius__m()

void aero_rep_single_particle_get_effective_radius__m	(	ModelData *	model_data,
		int	aero_phase_idx,
		double *	radius,
		double *	partial_deriv,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the effective particle radius \(r_{eff}\) (m)

Parameters

model_data	Pointer to the model data, including the state array
aero_phase_idx	Index of the aerosol phase within the representation
radius	Effective particle radius (m)
partial_deriv	\(\frac{\partial r_{eff}}{\partial y}\) where \(y\) are species on the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 153 of file aero_rep_single_particle.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_single_particle_get_number_conc__n_m3()

void aero_rep_single_particle_get_number_conc__n_m3	(	ModelData *	model_data,
		int	aero_phase_idx,
		double *	number_conc,
		double *	partial_deriv,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Get the particle number concentration \(n\) ( \(\mbox{\si{\#\per\cubic\metre}}\))

This single particle number concentration is set by the aerosol model prior to solving the chemistry. Thus, all \(\frac{\partial n}{\partial y}\) are zero. Also, there is only one set of particles in the single particle representation, so the phase index is not used.

Parameters

model_data	Pointer to the model data, including the state array
aero_phase_idx	Index of the aerosol phase within the representation (not used)
number_conc	Particle number concentration, \(n\) ( \(\mbox{\si{\#\per\cubic\metre}}\))
partial_deriv	\(\frac{\partial n}{\partial y}\) where \(y\) are the species on the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 212 of file aero_rep_single_particle.c.

Here is the caller graph for this function:

◆ aero_rep_single_particle_get_used_jac_elem()

int aero_rep_single_particle_get_used_jac_elem	(	ModelData *	model_data,
		int	aero_phase_idx,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		bool *	jac_struct
	)

Flag Jacobian elements used in calcualtions of mass and volume.

Parameters

aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
model_data	Pointer to the model data
aero_phase_idx	Index of the aerosol phase to find elements for
jac_struct	1D array of flags indicating potentially non-zero Jacobian elements. (The dependent variable should have been chosen by the calling function.)

Returns: Number of Jacobian elements flagged

Definition at line 52 of file aero_rep_single_particle.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aero_rep_single_particle_print()

void aero_rep_single_particle_print	(	int *	aero_rep_int_data,
		double *	aero_rep_float_data
	)

Print the Single Particle reaction parameters.

Parameters

aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data

Definition at line 414 of file aero_rep_single_particle.c.

Here is the caller graph for this function:

◆ aero_rep_single_particle_set_number_update_data__n_m3()

void aero_rep_single_particle_set_number_update_data__n_m3	(	void *	update_data,
		int	aero_rep_id,
		int	particle_id,
		double	number_conc
	)

Set number update data (#/m3)

Parameters

update_data	Pointer to an allocated number update data object
aero_rep_id	Id of the aerosol representation(s) to update
particle_id	Id of the computational particle
number_conc	New particle number (#/m3)

Definition at line 458 of file aero_rep_single_particle.c.

◆ aero_rep_single_particle_update_data()

bool aero_rep_single_particle_update_data	(	void *	update_data,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Update aerosol representation data.

Single particle aerosol representation update data is structured as follows:

int aero_rep_id (Id of one or more aerosol representations set by the host model using the camp_aero_rep_single_particle::aero_rep_single_particle_t::set_id function prior to initializing the solver.)
int update_type (Type of update to perform. Can be UPDATE_NUMBER only.)
double new_value (Either the new radius (m) or the new number concentration ( \(\mbox{\si{\#\per\cubic\centi\metre}}\)).)

Parameters

update_data	Pointer to the updated aerosol representation data
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Returns: Flag indicating whether this is the aerosol representation to update

Definition at line 383 of file aero_rep_single_particle.c.

Here is the caller graph for this function:

◆ aero_rep_single_particle_update_env_state()

void aero_rep_single_particle_update_env_state	(	ModelData *	model_data,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Update aerosol representation data for new environmental conditions.

The single particle aerosol representation does not use environmental conditions

Parameters

model_data	Pointer to the model data
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 108 of file aero_rep_single_particle.c.

Here is the caller graph for this function:

◆ aero_rep_single_particle_update_state()

void aero_rep_single_particle_update_state	(	ModelData *	model_data,
		int *	aero_rep_int_data,
		double *	aero_rep_float_data,
		double *	aero_rep_env_data
	)

Update aerosol representation data for a new state.

Parameters

model_data	Pointer to the model data, include the state array
aero_rep_int_data	Pointer to the aerosol representation integer data
aero_rep_float_data	Pointer to the aerosol representation floating-point data
aero_rep_env_data	Pointer to the aerosol representation environment-dependent parameters

Definition at line 129 of file aero_rep_single_particle.c.

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation

◆ aero_rep_modal_binned_mass_create_gmd_update_data()

◆ aero_rep_modal_binned_mass_create_gsd_update_data()

◆ aero_rep_modal_binned_mass_get_aero_conc_type()

◆ aero_rep_modal_binned_mass_get_aero_phase_avg_MW__kg_mol()

◆ aero_rep_modal_binned_mass_get_aero_phase_mass__kg_m3()

◆ aero_rep_modal_binned_mass_get_dependencies()

◆ aero_rep_modal_binned_mass_get_effective_radius__m()

◆ aero_rep_modal_binned_mass_get_number_conc__n_m3()

◆ aero_rep_modal_binned_mass_get_used_jac_elem()

◆ aero_rep_modal_binned_mass_print()

◆ aero_rep_modal_binned_mass_set_gmd_update_data()

◆ aero_rep_modal_binned_mass_set_gsd_update_data()

◆ aero_rep_modal_binned_mass_update_data()

◆ aero_rep_modal_binned_mass_update_env_state()

◆ aero_rep_modal_binned_mass_update_state()

◆ aero_rep_single_particle_create_number_update_data()

◆ aero_rep_single_particle_get_aero_conc_type()

◆ aero_rep_single_particle_get_aero_phase_avg_MW__kg_mol()

◆ aero_rep_single_particle_get_aero_phase_mass__kg_m3()

◆ aero_rep_single_particle_get_dependencies()

◆ aero_rep_single_particle_get_effective_radius__m()

◆ aero_rep_single_particle_get_number_conc__n_m3()

◆ aero_rep_single_particle_get_used_jac_elem()

◆ aero_rep_single_particle_print()

◆ aero_rep_single_particle_set_number_update_data__n_m3()

◆ aero_rep_single_particle_update_data()

◆ aero_rep_single_particle_update_env_state()

◆ aero_rep_single_particle_update_state()