ParameterFloat

A mutable struct representing a parameter with a Float64 value.

Fields

• value::Float64: The numerical value of the parameter
• name::String: The name of the parameter
• units::String: The units of the parameter
• description::String: A description of what the parameter represents
• parser::Function: A function to parse the parameter value from a string

ParameterInt

A mutable struct representing a parameter with an Int64 value.

Fields

• value::Int64: The numerical value of the parameter
• name::String: The name of the parameter
• units::String: The units of the parameter
• description::String: A description of what the parameter represents
• parser::Function: A function to parse the parameter value from a string

ParameterStr

A mutable struct representing a parameter with a String value.

Fields

• value::String: The string value of the parameter
• name::String: The name of the parameter
• units::String: The units of the parameter
• description::String: A description of what the parameter represents
• parser::Function: A function to parse the parameter value from a string

Array1DIntState

Mutable struct representing a 1D integer array with associated metadata.

Fields

• array::Vector{Int}: The 1D integer array data
• name::String: Name of the array
• units::String: Physical units of the array values
• description::String: Description of the array's purpose

Array1DFloatState

Mutable struct representing a 1D float array with associated metadata.

Fields

• array::Vector{Float64}: The 1D float array data
• name::String: Name of the array
• units::String: Physical units of the array values
• description::String: Description of the array's purpose

GridArray1DState

Struct representing a 1D grid array with associated metadata.

Fields

• array: the actual array data (Vector{Float64})
• name: identifier for the array
• units: physical units of the array values
• description: detailed description of what the array represents

RhsHeatArray1DState

Struct containing 1D array for heat equation right-hand side.

Fields

• array: 1D array of float64 values
• name: Name of the array
• units: Units of the array values
• description: Description of what the array represents

RhsStokesArray1DState

Struct containing a 1D array for Stokes equation right-hand side.

Fields

• array: the 1D array data
• name: name of the array
• units: physical units of the array values
• description: description of the array's purpose

SolutionArray1DState

Mutable struct representing a 1D solution array with associated metadata.

Fields

• array::Vector{Float64}: The 1D array data
• name::String: Name of the array
• units::String: Physical units of the array values
• grid_type::String: Type of grid (always "solution")
• description::String: Description of the array's purpose
• outform::OutputFormat: Output formatting specifications

MaterialArrayFloat1DState

Mutable struct representing a 1D material array with associated metadata.

Fields

• array::Vector{Float64}: The 1D array data
• name::String: Name of the array
• units::Vector{String}: List of physical units
• description::Vector{String}: List of descriptions

MaterialArrayInt1DState

Mutable struct representing a 1D material array with associated metadata.

Fields

• array::Vector{Int64}: The 1D array data
• name::String: Name of the array
• units::Vector{String}: List of physical units
• description::Vector{String}: List of descriptions

MarkerArrayFloat1DState{T<:AbstractFloat}

Mutable struct representing a 1D float marker array with associated metadata.

Type Parameters

• T<:AbstractFloat: The floating-point type for the array (e.g., Float64, Float32, Float16)

Fields

• array::Vector{T}: The 1D float array data for markers
• name::String: Name of the array
• units::String: Physical units of the array values
• description::String: Description of the array's purpose
• outform::OutputFormat: Output formatting specifications

MarkerArrayInt1DState{T<:Integer}

Mutable struct representing a 1D integer marker array with associated metadata.

Type Parameters

• T<:Integer: The integer type for the array (e.g., Int64, Int32, Int16)

Fields

• array::Vector{T}: The 1D integer array data for markers
• name::String: Name of the array
• units::String: Physical units of the array values
• description::String: Description of the array's purpose
• outform::OutputFormat: Output formatting specifications

InternalBcArrayFloatState

Struct representing a 1D internal boundary condition float array with associated metadata.

Fields

• array: the actual array data (Vector{Float64})
• name: identifier for the array
• description: array of detailed descriptions for each element

InternalBcArrayIntState

Struct representing a 1D internal boundary condition integer array with associated metadata.

Fields

• array: the actual array data (Vector{Int})
• name: identifier for the array
• description: array of detailed descriptions for each element

ScalarArray2DState

Mutable struct representing a 2D scalar array with associated metadata.

Fields

• ny::Int64: Number of nodes in the y-direction
• nx::Int64: Number of nodes in the x-direction
• array::Matrix{Float64}: The 2D array data
• name::String: Name of the array
• units::String: Physical units of the array values
• grid_type::String: Type of grid ("basic", "pressure", "vx", "vy")
• description::String: Description of the array's purpose
• outform::OutputFormat: Output formatting specifications

BcArrayFloatState

Struct representing a 2D boundary condition array with associated metadata.

Fields

• array: the actual array data (Matrix{Float64})
• name: identifier for the array
• units: physical units of the array values
• description: detailed description of what the array represents

MaterialArrayFloat2DState

Mutable struct representing a 2D material array with associated metadata.

Fields

• array::Matrix{Float64}: The 2D array data
• name::String: Name of the array
• units::Vector{String}: List of physical units
• description::Vector{String}: List of descriptions

MaterialArrayInt2DState

Mutable struct representing a 2D material array with associated metadata.

Fields

• array::Matrix{Int64}: The 2D array data
• name::String: Name of the array
• units::Vector{String}: List of physical units
• description::Vector{String}: List of descriptions

TopoArray2DState

A struct for storing 2D topography data arrays with metadata.

Fields

• array::Matrix{Float64}: The 2D array of float64 values
• name::String: Name of the array
• units::Vector{String}: Units for the array values
• description::Vector{String}: Description of the array contents

CarbArray2DState

A struct for storing 2D carbonate data arrays with metadata.

Fields

• array::Matrix{Float64}: The 2D array of float64 values
• name::String: Name of the array
• units::Vector{String}: Units for the array values
• description::Vector{String}: Description of the array contents

ScalarArray3DState

Mutable struct representing a 3D scalar array with associated metadata.

Fields

• ny::Int64: Number of nodes in the y-direction
• nx::Int64: Number of nodes in the x-direction
• nz::Int64: Number of nodes in the z-direction
• array::Matrix{Float64}: The 3D array data
• name::String: Name of the array
• units::String: Physical units of the array values
• grid_type::String: Type of grid ("basic", "pressure", "vx", "vy")
• description::String: Description of the array's purpose
• outform::OutputFormat: Output formatting specifications

MaterialColors

Struct with material color information.

Fields

• color_map::[Union{Any, Nothing}]:
  • Color map for material colors
• n_bin::[Union{Int64, Nothing}]:
  • Number of material colors
• labels::[Union{Vector{String}, Nothing}]:
  • Labels for material colors with format: material type : material domain : (material name)
• ticks::[Union{Vector{Float64}, Nothing}]:
  • Ticks for the colorbar
• colorrange::[Union{Tuple{Float64, Float64}, Nothing}]:
  • Color range for the colorbar specifically for CairoMakie where for material ID's ranging from 1tonbinthe colorbar range should be from1 - 0.5tonbin + 0.5` to maintain proper spacing between the colorbar ticks.