hydro_parameters.h File Reference

#include <config.h>
#include "inline.h"

Include dependency graph for hydro_parameters.h:

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

Go to the source code of this file.

Data Structures
struct	viscosity_global_data
struct	diffusion_global_data

Macros
#define	const_viscosity_beta   3.0f
#define	hydro_props_default_viscosity_alpha_feedback_reset   0.8f
#define	hydro_props_default_viscosity_alpha   0.8f

Functions
static INLINE void	viscosity_init (struct swift_params *params, const struct unit_system *us, const struct phys_const *phys_const, struct viscosity_global_data *viscosity)
	Initialises the viscosity parameters in the struct from the parameter file, or sets them to defaults.
static INLINE void	viscosity_init_no_hydro (struct viscosity_global_data *viscosity)
	Initialises a viscosity struct to sensible numbers for mocking purposes.
static INLINE void	viscosity_print (const struct viscosity_global_data *viscosity)
	Prints out the viscosity parameters at the start of a run.
static INLINE void	diffusion_init (struct swift_params *params, const struct unit_system *us, const struct phys_const *phys_const, struct diffusion_global_data *diffusion)
	Initialises the diffusion parameters in the struct from the parameter file, or sets them to defaults.
static INLINE void	diffusion_init_no_hydro (struct diffusion_global_data *diffusion)
	Initialises a diffusion struct to sensible numbers for mocking purposes.
static INLINE void	diffusion_print (const struct diffusion_global_data *diffusion)
	Prints out the diffusion parameters at the start of a run.

Macro Definition Documentation

const_viscosity_beta

#define const_viscosity_beta   3.0f

Definition at line 51 of file hydro_parameters.h.

hydro_props_default_viscosity_alpha

#define hydro_props_default_viscosity_alpha   0.8f

Definition at line 63 of file hydro_parameters.h.

Referenced by viscosity_init(), and viscosity_init_no_hydro().

hydro_props_default_viscosity_alpha_feedback_reset

#define hydro_props_default_viscosity_alpha_feedback_reset   0.8f

Definition at line 57 of file hydro_parameters.h.

Function Documentation

diffusion_init()

static INLINE void diffusion_init ( struct swift_params * params, const struct unit_system * us, const struct phys_const * phys_const, struct diffusion_global_data * diffusion )

static

Initialises the diffusion parameters in the struct from the parameter file, or sets them to defaults.

Parameters

params	the pointer to the swift_params file
us	pointer to the internal unit system
phys_const	pointer to the physical constants system
diffusion	pointer to the diffusion struct to be filled.

Definition at line 155 of file hydro_parameters.h.

diffusion_init_no_hydro()

static INLINE void diffusion_init_no_hydro ( struct diffusion_global_data * diffusion )

static

Initialises a diffusion struct to sensible numbers for mocking purposes.

Parameters

diffusion

pointer to the diffusion_global_data struct to be filled.

Definition at line 166 of file hydro_parameters.h.

diffusion_print()

static INLINE void diffusion_print ( const struct diffusion_global_data * diffusion )

static

Prints out the diffusion parameters at the start of a run.

Parameters

diffusion

pointer to the diffusion_global_data struct found in hydro_properties

Definition at line 175 of file hydro_parameters.h.

viscosity_init()

static INLINE void viscosity_init ( struct swift_params * params, const struct unit_system * us, const struct phys_const * phys_const, struct viscosity_global_data * viscosity )

static

Initialises the viscosity parameters in the struct from the parameter file, or sets them to defaults.

Parameters

params	the pointer to the swift_params file
us	pointer to the internal unit system
phys_const	pointer to the physical constants system
viscosity	pointer to the viscosity_global_data struct to be filled.

Definition at line 95 of file hydro_parameters.h.

References viscosity_global_data::alpha, and hydro_props_default_viscosity_alpha.

viscosity_init_no_hydro()

static INLINE void viscosity_init_no_hydro ( struct viscosity_global_data * viscosity )

static

Initialises a viscosity struct to sensible numbers for mocking purposes.

Parameters

viscosity

pointer to the viscosity_global_data struct to be filled.

Definition at line 112 of file hydro_parameters.h.

References viscosity_global_data::alpha, and hydro_props_default_viscosity_alpha.

viscosity_print()

static INLINE void viscosity_print ( const struct viscosity_global_data * viscosity )

static

Prints out the viscosity parameters at the start of a run.

Parameters

viscosity

pointer to the viscosity_global_data struct found in hydro_properties

Definition at line 123 of file hydro_parameters.h.