cs_atmo_chemistry.h File Reference

#include "base/cs_defs.h"

Include dependency graph for cs_atmo_chemistry.h:

Go to the source code of this file.

Classes
struct	cs_atmo_chemistry_t

Enumerations
enum	cs_atmo_aerosol_type_t { CS_ATMO_AEROSOL_OFF = 0 , CS_ATMO_AEROSOL_SSH = 1 }

Functions
void	cs_atmo_aerosol_initialize (void)
	This function initializes the external aerosol code. More...
void	cs_atmo_aerosol_finalize (void)
	This function finalizes the external aerosol code. More...
void	cs_atmo_aerosol_get_gas (cs_real_t *array)
	This function fills the given array with gas concentrations from the external aerosol code. More...
void	cs_atmo_aerosol_time_advance (void)
	This function computes a time step of gaseous chemistry and aerosols dynamic using the external aerosol code. More...
void	cs_atmo_chemistry_initialization_deactivate (void)
	Deactivate chemistry initialization procedure. More...
void	cs_atmo_chem_initialize_dlconc0 (void)
	initialize gaseous and particulate concentrations and aerosol number More...
void	cs_atmo_chemistry_initialize_conc_profiles (void)
	initialize (allocate) chemistry concentrations profiles More...
void	cs_atmo_chemistry_initialize_reacnum (void)
	Initialize chemistry cell kinetic rates arrays. More...
void	cs_atmo_chemistry_finalize (void)
	Finalize atmospheric chemistry structures. More...
void	cs_atmo_chemistry_log_setup (void)
	Print the atmospheric chemistry options to setup.log. More...
void	cs_atmo_aerosol_log_setup (void)
	Print the atmospheric aerosols options to setup.log. More...
int	cs_atmo_chemistry_need_initialization (void)
	Check if the chemistry module needs initialization. More...
void	cs_atmo_chemistry_set_aerosol_file_name (const char *file_name)
	This function sets the file name to initialize the aerosol library. More...
void	cs_atmo_chemistry_set_spack_file_name (const char *file_name)
	This function set the file name of the SPACK file. More...
void	cs_atmo_declare_chem_from_spack (void)
	This function declares additional transported variables for atmospheric module for the chemistry defined from SPACK. More...
void	cs_atmo_init_chemistry (void)
	Initialize chemistry array. More...
void	cs_atmo_read_aerosol (void)
	Reads initial aerosol concentration and number. More...
void	cs_atmo_read_chemistry_profile (int mode)
	Reads the chemistry profile data for the atmospheric chemistry. More...
void	cs_atmo_set_aero_conc_file_name (const char *file_name)
	This function set the file name of the aerosol concentration file. More...
void	cs_atmo_set_chem_conc_file_name (const char *file_name)
	This function set the file name of the chemistry file. More...
void	cs_atmo_chem_exp_source_terms (int f_id, cs_real_t st_exp[])
	Computes the explicit chemical source term for atmospheric chemistry in case of a semi-coupled resolution. More...
void	cs_atmo_compute_gaseous_chemistry (void)
	Calls the rosenbrock resolution for atmospheric chemistry. More...

Variables
cs_atmo_chemistry_t *	cs_glob_atmo_chemistry

Enumeration Type Documentation

cs_atmo_aerosol_type_t

enum cs_atmo_aerosol_type_t

Enumerator
CS_ATMO_AEROSOL_OFF
CS_ATMO_AEROSOL_SSH

Function Documentation

cs_atmo_aerosol_finalize()

void cs_atmo_aerosol_finalize

(

void

)

This function finalizes the external aerosol code.

cs_atmo_aerosol_get_gas()

void cs_atmo_aerosol_get_gas

(

cs_real_t *

array

)

This function fills the given array with gas concentrations from the external aerosol code.

Parameters

[out]

array

gas concentrations

cs_atmo_aerosol_initialize()

void cs_atmo_aerosol_initialize

(

void

)

This function initializes the external aerosol code.

cs_atmo_aerosol_log_setup()

void cs_atmo_aerosol_log_setup

(

void

)

Print the atmospheric aerosols options to setup.log.

cs_atmo_aerosol_time_advance()

void cs_atmo_aerosol_time_advance

(

void

)

This function computes a time step of gaseous chemistry and aerosols dynamic using the external aerosol code.

cs_atmo_chem_exp_source_terms()

void cs_atmo_chem_exp_source_terms	(	int	f_id,
		cs_real_t	st_exp[]
	)

Computes the explicit chemical source term for atmospheric chemistry in case of a semi-coupled resolution.

Parameters

[in]	f_id	field id
[out]	st_exp	explicit part of the source term

cs_atmo_chem_initialize_dlconc0()

void cs_atmo_chem_initialize_dlconc0

(

void

)

initialize gaseous and particulate concentrations and aerosol number

cs_atmo_chemistry_finalize()

void cs_atmo_chemistry_finalize

(

void

)

Finalize atmospheric chemistry structures.

cs_atmo_chemistry_initialization_deactivate()

void cs_atmo_chemistry_initialization_deactivate

(

void

)

Deactivate chemistry initialization procedure.

cs_atmo_chemistry_initialize_conc_profiles()

void cs_atmo_chemistry_initialize_conc_profiles

(

void

)

initialize (allocate) chemistry concentrations profiles

cs_atmo_chemistry_initialize_reacnum()

void cs_atmo_chemistry_initialize_reacnum

(

void

)

Initialize chemistry cell kinetic rates arrays.

cs_atmo_chemistry_log_setup()

void cs_atmo_chemistry_log_setup

(

void

)

Print the atmospheric chemistry options to setup.log.

cs_atmo_chemistry_need_initialization()

int cs_atmo_chemistry_need_initialization

(

void

)

Check if the chemistry module needs initialization.

Returns

int value : 1 if needed, 0 if not

cs_atmo_chemistry_set_aerosol_file_name()

void cs_atmo_chemistry_set_aerosol_file_name

(

const char *

file_name

)

This function sets the file name to initialize the aerosol library.

Parameters

[in]

file_name

name of the file.

cs_atmo_chemistry_set_spack_file_name()

void cs_atmo_chemistry_set_spack_file_name

(

const char *

file_name

)

This function set the file name of the SPACK file.

Parameters

[in]

file_name

name of the file.

cs_atmo_compute_gaseous_chemistry()

void cs_atmo_compute_gaseous_chemistry

(

void

)

Calls the rosenbrock resolution for atmospheric chemistry.

cs_atmo_declare_chem_from_spack()

void cs_atmo_declare_chem_from_spack

(

void

)

This function declares additional transported variables for atmospheric module for the chemistry defined from SPACK.

cs_atmo_init_chemistry()

void cs_atmo_init_chemistry

(

void

)

Initialize chemistry array.

cs_atmo_read_aerosol()

void cs_atmo_read_aerosol

(

void

)

Reads initial aerosol concentration and number.

cs_atmo_read_chemistry_profile()

void cs_atmo_read_chemistry_profile

(

int

mode

)

Reads the chemistry profile data for the atmospheric chemistry.

Parameters

[in]

mode

if false reading of dimensions only else reading of data

cs_atmo_set_aero_conc_file_name()

void cs_atmo_set_aero_conc_file_name

(

const char *

file_name

)

This function set the file name of the aerosol concentration file.

Parameters

[in]

file_name

name of the file.

This function set the file name of the aerosol concentration file.

Parameters

[in]

file_name

name of the file.

cs_atmo_set_chem_conc_file_name()

void cs_atmo_set_chem_conc_file_name

(

const char *

file_name

)

This function set the file name of the chemistry file.

Parameters

[in]

file_name

name of the file.

Variable Documentation

cs_glob_atmo_chemistry

cs_atmo_chemistry_t* cs_glob_atmo_chemistry

extern

Pointer to atmo chemistry structure