Source code for libs.test_case_0dparcel.run_0dparcel

"""
Copyright (c) 2024 MPI-M, Clara Bayley

----- Microphysics Test Cases -----
File: run_0dparcel.py
Project: test_case_0dparcel
Created Date: Thursday 29th February 2024
Author: Clara Bayley (CB)
Additional Contributors:
-----
Last Modified: Wednesday 4th June 2025
Modified By: CB
-----
License: BSD 3-Clause "New" or "Revised" License
https://opensource.org/licenses/BSD-3-Clause
-----
File Description:
run 0-D parcel model by timestepping and outputting data
"""

from .adiabatic_motion import AdiabaticMotion
from libs.thermo.output_thermodynamics import OutputThermodynamics




def run_0dparcel(time, time_end, timestep, thermo, microphys_scheme):
    """Run a 0-D parcel model with a specified microphysics scheme and parcel dynamics.

    This function runs a 0-D parcel model with the given initial thermodynamic conditions, and
    microphysics scheme from time to time_end with a constant timestep using an instance of
    AdiabaticMotion for the parcel dynamics.

    Parameters:
        time (float):
          Initial time for the simulation (s).
        time_end (float):
          End time for the simulation (s).
        timestep (float):
          Timestep for the simulation (s).
        thermo (Thermodynamics):
          Initial thermodynamic conditions.
        microphys_scheme:
          Microphysics scheme to use.

    Returns:
          OutputThermodynamics: Output containing thermodynamic data from the model run.
    """

    ### data to output during model run
    ntime = int(time_end / timestep) + 1
    out = OutputThermodynamics([ntime, 1])

    ### type of dynamics parcel will undergo
    amp = 11325  # amplitude of pressure sinusoid [Pa]
    tau = 120  # time period of pressure sinusiod [s]
    parcel_dynamics = AdiabaticMotion(amp, tau)

    ### run dynamics + microphysics from time to time_end
    microphys_scheme.initialize()

    out.output_thermodynamics(time, thermo)
    while time < time_end:
        thermo = parcel_dynamics.run(time, timestep, thermo)
        #    thermo.print_state()
        thermo = microphys_scheme.run(timestep, thermo)
        #    thermo.print_state()

        time += timestep

        out.output_thermodynamics(time, thermo)

    microphys_scheme.finalize()

    out.finalize()
    return out