romtools.workflows.models#

Protocol for interfacing with external applications

Classes

JobHandle(*args, **kwargs)

Minimal handle returned by a non-blocking model.

Model()

Baseline model protocol.

MultiFidelityQoiModel()

A QoI surrogate with predictions selectable by fidelity.

MultiFidelityQoiModelWithErrorEstimate()

Fidelity-selectable QoIs and scalar error/uncertainty indicators.

QoiModel()

Protocol for a model that has a return_qoi implementation

QoiModelWithErrorEstimate()

Protocol for a model that has a return_qoi and compute_error_estimate

class romtools.workflows.models.JobHandle(*args, **kwargs)[source]#

Bases: Protocol

Minimal handle returned by a non-blocking model.

done()[source]#

Return whether execution has completed.

Return type:

bool

result()[source]#

Wait if needed and return the process exit status.

Return type:

int

class romtools.workflows.models.Model[source]#

Bases: Protocol

Baseline model protocol.

Set blocking = False on models that return a JobHandle. The executor defaults to blocking when the attribute is absent.

populate_run_directory(run_directory, parameter_sample)[source]#

This function is called from the base directory and is responsible for populating the run directory located at run_directory.

Examples would be setting up input files, linking mesh files.

Parameters:
  • run_directory (str) – Absolute path to run_directory.

  • parameter_sample (dict) – Dictionary containing parameter names and sample values

Return type:

None

run_model(run_directory, parameter_sample)[source]#

Execute the model. Blocking models return an integer exit status. Non-blocking models return a JobHandle.

Parameters:
  • run_directory (str) – Absolute path to run_directory.

  • parameter_sample (dict) – Dictionary containing parameter names and sample values

Return type:

int | JobHandle

class romtools.workflows.models.MultiFidelityQoiModel[source]#

Bases: QoiModel, Protocol

A QoI surrogate with predictions selectable by fidelity.

Fidelity indices are ordered from lowest (0) to highest (-1). Omitting fidelity preserves the original QoiModel call signature.

compute_qoi(run_directory, parameter_sample, fidelity=-1)[source]#

This function is called from a run directory AFTER run_model has been run

Parameters:
  • run_directory (str)

  • parameter_sample (dict)

  • fidelity (int)

Return type:

ndarray

class romtools.workflows.models.MultiFidelityQoiModelWithErrorEstimate[source]#

Bases: MultiFidelityQoiModel, QoiModelWithErrorEstimate, Protocol

Fidelity-selectable QoIs and scalar error/uncertainty indicators.

compute_error_estimate(run_directory, parameter_sample, fidelity=-1)[source]#

This function is called from a run directory AFTER run_model has been run

Parameters:
  • run_directory (str)

  • parameter_sample (dict)

  • fidelity (int)

Return type:

float

class romtools.workflows.models.QoiModel[source]#

Bases: Model, Protocol

Protocol for a model that has a return_qoi implementation

compute_qoi(run_directory, parameter_sample)[source]#

This function is called from a run directory AFTER run_model has been run

Parameters:
  • run_directory (str)

  • parameter_sample (dict)

Return type:

ndarray

class romtools.workflows.models.QoiModelWithErrorEstimate[source]#

Bases: QoiModel, Protocol

Protocol for a model that has a return_qoi and compute_error_estimate

compute_error_estimate(run_directory, parameter_sample)[source]#

This function is called from a run directory AFTER run_model has been run

Parameters:
  • run_directory (str)

  • parameter_sample (dict)

Return type:

float