Update class output structure

Author: Peter9192

apps/class-solid/src/components/Analysis.tsx

@@ -1,7 +1,7 @@
 import type { Config } from "@classmodel/class/config";
 import { calculatePlume, transposePlumeData } from "@classmodel/class/fire";
 import {
-  type ClassOutput,
+  type ClassTimeSeries,
   type OutputVariableKey,
   getOutputAtTime,
   outputVariables,
@@ -78,7 +78,7 @@ interface FlatExperiment {
   color: string;
   linestyle: string;
   config: Config;
-  output?: ClassOutput;
+  output?: ClassTimeSeries;
 }
 
 // Create a derived store for looping over all outputs:
@@ -322,8 +322,7 @@ export function VerticalProfilePlot({
     ...observations().flatMap((obs) => obs.data.map((d) => d.y)),
   ];
 
-  // TODO: better to include jump at top in extent calculation rather than adding random margin.
-  const xLim = () => getNiceAxisLimits(allX(), 1);
+  const xLim = () => getNiceAxisLimits(allX(), 0);
   const yLim = () => [0, getNiceAxisLimits(allY(), 0)[1]] as [number, number];
 
   function chartData() {

apps/class-solid/src/lib/download.ts

@@ -1,4 +1,7 @@
-import type { ClassOutput, OutputVariableKey } from "@classmodel/class/output";
+import type {
+  ClassTimeSeries,
+  OutputVariableKey,
+} from "@classmodel/class/output";
 import { BlobReader, BlobWriter, ZipWriter } from "@zip.js/zip.js";
 import { toPartial } from "./encode";
 import type { ExperimentConfig } from "./experiment_config";
@@ -11,7 +14,7 @@ export function toConfigBlob(experiment: ExperimentConfig) {
   });
 }
 
-function outputToCsv(output: ClassOutput) {
+function outputToCsv(output: ClassTimeSeries) {
   const headers = Object.keys(output) as OutputVariableKey[];
   const lines = [headers.join(",")];
   for (let i = 0; i < output[headers[0]].length; i++) {

apps/class-solid/src/lib/runner.ts

@@ -1,6 +1,5 @@
 import type { Config } from "@classmodel/class/config";
-import type { ClassOutput } from "@classmodel/class/output";
-import type { runClass } from "@classmodel/class/runner";
+import type { ClassData, runClass } from "@classmodel/class/runner";
 import { wrap } from "comlink";
 
 const worker = new Worker(new URL("./worker.ts", import.meta.url), {
@@ -9,7 +8,7 @@ const worker = new Worker(new URL("./worker.ts", import.meta.url), {
 
 const asyncRunner = wrap<typeof runClass>(worker);
 
-export async function runClassAsync(config: Config): Promise<ClassOutput> {
+export async function runClassAsync(config: Config): Promise<ClassData> {
   try {
     const output = asyncRunner(config);
     return output;

apps/class-solid/src/lib/store.ts

@@ -2,21 +2,22 @@ import { createUniqueId } from "solid-js";
 import { createStore, produce, unwrap } from "solid-js/store";
 
 import type { Config } from "@classmodel/class/config";
-import type { ClassOutput } from "@classmodel/class/output";
 
 import {
   mergeConfigurations,
   pruneConfig,
 } from "@classmodel/class/config_utils";
+
+import type { ClassData } from "@classmodel/class/runner";
 import { decodeAppState } from "./encode";
 import { parseExperimentConfig } from "./experiment_config";
 import type { ExperimentConfig } from "./experiment_config";
 import { findPresetByName } from "./presets";
 import { runClassAsync } from "./runner";
 
 interface ExperimentOutput {
-  reference?: ClassOutput;
-  permutations: Array<ClassOutput | undefined>;
+  reference?: ClassData;
+  permutations: Array<ClassData | undefined>;
   running: number | false;
 }
 

packages/class/src/cli.ts

@@ -7,7 +7,7 @@ import { readFile, writeFile } from "node:fs/promises";
 import { EOL } from "node:os";
 import { Command, Option } from "@commander-js/extra-typings";
 import { jsonSchemaOfConfig } from "./config.js";
-import type { ClassOutput, OutputVariableKey } from "./output.js";
+import type { ClassTimeSeries, OutputVariableKey } from "./output.js";
 import { runClass } from "./runner.js";
 import { parse } from "./validate.js";
 
@@ -51,7 +51,7 @@ async function writeTextFile(body: string, fn: string): Promise<void> {
 /**
  * Create a DSV (delimiter-separated values) string from an object of arrays.
  */
-function dsv(output: ClassOutput, delimiter: string): string {
+function dsv(output: ClassTimeSeries, delimiter: string): string {
   const keys = Object.keys(output) as OutputVariableKey[];
   // order of headers is now in which they were added to the object
   // TODO make configurable: which columns and in which order
@@ -67,7 +67,7 @@ function dsv(output: ClassOutput, delimiter: string): string {
 /**
  * Format the output.
  */
-function formatOutput(output: ClassOutput, format: string): string {
+function formatOutput(output: ClassTimeSeries, format: string): string {
   switch (format) {
     case "json":
       return JSON.stringify(output, null, 2);

packages/class/src/fire.ts

@@ -62,6 +62,8 @@ export interface Parcel {
   rh: number; // Relative humidity [%]
 }
 
+export type FirePlume = Parcel[];
+
 /**
  * Initialize fire parcel with ambient conditions and fire properties
  */
@@ -144,7 +146,7 @@ export function calculatePlume(
   fire: FireConfig,
   bg: ClassProfile,
   plumeConfig: PlumeConfig = defaultPlumeConfig,
-): Parcel[] {
+): FirePlume {
   const { dz } = plumeConfig;
   let parcel = initializeFireParcel(bg, fire);
   const plume: Parcel[] = [parcel];

packages/class/src/output.ts

@@ -118,14 +118,4 @@ export const outputVariables = {
 } as const satisfies Record<string, VariableInfo>;
 
 export type OutputVariableKey = keyof typeof outputVariables;
-export type ClassOutput = Record<OutputVariableKey, number[]>;
-export type ClassOutputAtSingleTime = Record<OutputVariableKey, number>;
-
-export function getOutputAtTime(
-  output: ClassOutput,
-  timeIndex: number,
-): ClassOutputAtSingleTime {
-  return Object.fromEntries(
-    Object.entries(output).map(([key, values]) => [key, values[timeIndex]]),
-  ) as ClassOutputAtSingleTime;
-}
+export type ClassOutput = Record<OutputVariableKey, number>;

packages/class/src/profiles.ts

@@ -1,7 +1,7 @@
 // profiles.ts
 
 import type { MixedLayerConfig, NoWindConfig, WindConfig } from "./config.js";
-import type { ClassOutputAtSingleTime } from "./output.js";
+import type { ClassOutput } from "./output.js";
 import {
   dewpoint,
   qsatLiq,
@@ -55,7 +55,7 @@ export const NoProfile: ClassProfile = {
  */
 export function generateProfiles(
   config: MixedLayerConfig & (WindConfig | NoWindConfig),
-  output: ClassOutputAtSingleTime,
+  output: ClassOutput,
   dz = 1,
 ): ClassProfile {
   const { Rd, cp, g } = CONSTANTS;

packages/class/src/runner.ts

@@ -5,38 +5,62 @@
  */
 import { CLASS } from "./class.js";
 import type { Config } from "./config.js";
+import { type FirePlume, calculatePlume } from "./fire.js";
 import {
   type ClassOutput,
   type OutputVariableKey,
   outputVariables,
 } from "./output.js";
+import { type ClassProfile, generateProfiles } from "./profiles.js";
 import { parse } from "./validate.js";
 
+type ClassTimeSeries = Record<OutputVariableKey, number[]>;
+type ClassProfiles = ClassProfile[];
+type ClassFirePlumes = FirePlume[];
+export type ClassData = [ClassTimeSeries, ClassProfiles?, ClassFirePlumes?];
+
 /**
  * Runs the CLASS model with the given configuration and frequency.
  *
  * @param config - The configuration object for the CLASS model.
  * @param freq - The frequency in seconds at which to write output, defaults to 600.
  * @returns An object containing the output variables collected during the simulation.
  */
-export function runClass(config: Config, freq = 600): ClassOutput {
+export function runClass(config: Config, freq = 600): ClassData {
   const validatedConfig = parse(config);
   const model = new CLASS(validatedConfig);
 
-  const output_keys = Object.keys(outputVariables) as OutputVariableKey[];
+  const outputKeys = Object.keys(outputVariables) as OutputVariableKey[];
 
   const writeOutput = () => {
-    for (const key of output_keys) {
+    const output: Partial<ClassOutput> = {};
+    for (const key of outputKeys) {
       const value = model.getValue(key);
       if (value !== undefined) {
-        (output[key] as number[]).push(value as number);
+        output[key] = model.getValue(key);
+        timeSeries[key].push(value as number);
+      }
+
+      // Include profiles
+      if (config.sw_ml) {
+        const profile = generateProfiles(config, output as ClassOutput);
+        profiles.push(profile);
+
+        // Include fireplumes
+        if (config.sw_fire) {
+          const plume = calculatePlume(config, profile);
+          firePlumes.push(plume);
+        }
       }
     }
   };
 
-  const output = Object.fromEntries(
-    output_keys.map((key) => [key, []]),
-  ) as unknown as ClassOutput;
+  // Initialize output arrays
+  const timeSeries = Object.fromEntries(
+    outputKeys.map((key) => [key, []]),
+  ) as unknown as ClassTimeSeries;
+  const profiles: ClassProfiles = [];
+  const firePlumes: ClassFirePlumes = [];
 
   // Initial time
   writeOutput();
@@ -50,5 +74,12 @@ export function runClass(config: Config, freq = 600): ClassOutput {
     }
   }
 
-  return output;
-}
+  // Construct ClassData
+  if (config.sw_ml) {
+    if (config.sw_fire) {
+      return [timeSeries, profiles, firePlumes];
+    }
+    return [timeSeries, profiles];
+  }
+  return [timeSeries];
+}