jf1uids.fluid_equations.total_quantities module

jf1uids.fluid_equations.total_quantities module#

jf1uids.fluid_equations.total_quantities.calculate_gravitational_energy(state, helper_data, gravitational_constant, config, registered_variables)[source]#
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_total_energy(primitive_state: Float[Array, 'num_vars num_cells_x'] | Float[Array, 'num_vars num_cells_x num_cells_y'] | Float[Array, 'num_vars num_cells_x num_cells_y num_cells_z'], helper_data: HelperData, gamma: float | Float[Array, ''], gravitational_constant: float | Float[Array, ''], config: SimulationConfig, registered_variables: RegisteredVariables) → Float[Array, ''][source]#

Calculate the total energy in the domain.

Parameters:

  • 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: Float[Array, 'num_vars num_cells_x'] | Float[Array, 'num_vars num_cells_x num_cells_y'] | Float[Array, 'num_vars num_cells_x num_cells_y num_cells_z'], helper_data: HelperData, config: SimulationConfig) → Float[Array, ''][source]#

Calculate the total mass in the domain.

Parameters:

  • primitive_state – The primitive state array.

  • helper_data – The helper data.

  • config – The simulation configuration.

Returns:

The total mass.