astronomix._fluid_equations.total_quantities

Domain-integrated diagnostic quantities.

Computes globally integrated quantities of the fluid state (internal, kinetic, gravitational and total energy, total mass and radial momentum) used for the simulation diagnostics.

Module Contents

Functions

calculate_internal_energy
calculate_radial_momentum
calculate_kinetic_energy
calculate_gravitational_energy
calculate_total_energy	Calculate the total energy in the domain.
calculate_total_mass	Calculate the total mass in the domain.

API

astronomix._fluid_equations.total_quantities.calculate_internal_energy(state, helper_data, gamma, config, registered_variables)

astronomix._fluid_equations.total_quantities.calculate_radial_momentum(state, helper_data, config, registered_variables)

astronomix._fluid_equations.total_quantities.calculate_kinetic_energy(state, helper_data, config, registered_variables)

astronomix._fluid_equations.total_quantities.calculate_gravitational_energy(state, helper_data, gravitational_constant, params, config, registered_variables)

astronomix._fluid_equations.total_quantities.calculate_total_energy(primitive_state: astronomix.option_classes.simulation_config.STATE_TYPE, helper_data: astronomix.data_classes.simulation_helper_data.HelperData, gamma: Union[float, jaxtyping.Float[jaxtyping.Array]], gravitational_constant: Union[float, jaxtyping.Float[jaxtyping.Array]], params: astronomix.option_classes.simulation_params.SimulationParams, config: astronomix.option_classes.simulation_config.SimulationConfig, registered_variables: astronomix.variable_registry.registered_variables.RegisteredVariables) → jaxtyping.Float[jaxtyping.Array]

Calculate the total energy in the domain.

Args:

primitive_state: The primitive state array. helper_data: The helper data. gamma: The adiabatic index. gravitational_constant: The gravitational constant. params: The simulation parameters (provides the external potential). config: The simulation configuration. registered_variables: The registered variables.

Returns:

The total energy.

astronomix._fluid_equations.total_quantities.calculate_total_mass(primitive_state: astronomix.option_classes.simulation_config.STATE_TYPE, helper_data: astronomix.data_classes.simulation_helper_data.HelperData, config: astronomix.option_classes.simulation_config.SimulationConfig) → jaxtyping.Float[jaxtyping.Array]

Calculate the total mass in the domain.

Args:

primitive_state: The primitive state array. helper_data: The helper data. config: The simulation configuration.

Returns:

The total mass.