API Reference

This section provides a detailed reference of the Z3ST core modules, including solver setup, configuration management, and mesh handling.

Core Modules

class Config(input_file)

Bases: object

Configuration manager for Z3ST simulations.

This class parses the user input YAML file and initializes the global configuration used by all other modules (mesh, solvers, models).

It loads:

• active physical models (thermal, mechanical, gap conductance)

• solver settings (linear/non-linear, tolerances, coupling scheme)

• paths for geometry, mesh, and boundary conditions

• number of time steps

__init__(input_file)

Initialize the Config class from a YAML input dictionary.

Parameters:

input_file (dict) – Parsed YAML configuration file containing all simulation parameters.

Physics Models

Diagnostics

Mesh management