jf1uids.fluid_equations.total_quantities

`jf1uids.fluid_equations.total_quantities`#

`calculate_internal_energy`
`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.

jf1uids.fluid_equations.total_quantities.calculate_internal_energy(state, helper_data, gamma, config, registered_variables)[source]#

jf1uids.fluid_equations.total_quantities.calculate_kinetic_energy(state, helper_data, config, registered_variables)[source]#

jf1uids.fluid_equations.total_quantities.calculate_gravitational_energy(state, helper_data, gravitational_constant, config, registered_variables)[source]#

jf1uids.fluid_equations.total_quantities.calculate_total_energy(primitive_state: jf1uids.option_classes.simulation_config.STATE_TYPE, helper_data: jf1uids.data_classes.simulation_helper_data.HelperData, gamma: Union[float, jaxtyping.Float[jaxtyping.Array]], gravitational_constant: Union[float, jaxtyping.Float[jaxtyping.Array]], config: jf1uids.option_classes.simulation_config.SimulationConfig, registered_variables: jf1uids.fluid_equations.registered_variables.RegisteredVariables) → jaxtyping.Float[jaxtyping.Array][source]#

Calculate the total energy in the domain.

Args:: primitive_state: The primitive state array. helper_data: The helper data. gamma: The adiabatic index. num_ghost_cells: The number of ghost cells.
Returns:: The total energy.

jf1uids.fluid_equations.total_quantities.calculate_total_mass(primitive_state: jf1uids.option_classes.simulation_config.STATE_TYPE, helper_data: jf1uids.data_classes.simulation_helper_data.HelperData, config: jf1uids.option_classes.simulation_config.SimulationConfig) → jaxtyping.Float[jaxtyping.Array][source]#

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.