[FEATURE] - OutputControl for only specific stress periods.

[JoerivanEngelen]

Another one from @jdelsman: In our implementation of the OutputControl with times, we don't support the following usecase: For MODFLOW6, users have to manually turn off output control for times where they don't want output. That is quite annoying to do manually, so it would be nice to have a better API for this. The times argument leads to some users thinking this does what they want: Only output for specific timesteps, but instead specifying times only allows users to switch from settings per stress period like "all" to "first".

[jdelsman]

We now use this hack, running below function after writing of the model:

def process_period_blocks(modeldir):
"""
Alters the OC file to ensure only the specified outputs are saved.
"""
for fn in Path(modeldir).glob("**/oc.oc"):
# rename original file
fn_org = fn.parent / f"{fn.stem}_org.oc"
if not fn_org.exists():
shutil.copyfile(fn, fn_org)

    with open(fn_org, "r") as f, open(fn, "w") as f_out:
        periods = []  # To keep track of period numbers in order
        # Process each line
        for line in f:
            # Check if the line defines a "begin period"
            if line.strip().startswith("begin period"):
                # Extract the period number
                period_number = int(line.strip().split()[2])
                periods.append(period_number)
                #
                # Check if the previous period is missing (increment by 1)
                if len(periods) > 1 and periods[-1] != periods[-2] + 1:
                    # Insert the missing period block
                    missing_period = periods[-2] + 1
                    f_out.write(f"begin period {missing_period}\nend period\n")
            f_out.write(line)