Tiles

JacobianStyle

Trait for indicating Jacobian sparsity of a CryoGrid ODEProblem.

JacobianStyle(::AbstractTile)

Can be overriden/extended to specify Jacobian structure for specific Tiles.

Stratigraphy{N,TLayers<:NamedTuple,TBoundaries}

Defines a 1-dimensional stratigraphy by connecting a top and bottom layer to one or more subsurface layers.

Tile{TStrat,TGrid,TStates,TInits,TEvents,iip} <: AbstractTile{iip}

Defines the full specification of a single CryoGrid tile; i.e. stratigraphy, grid, and state variables.

Tile(integrator::SciMLBase.DEIntegrator)

Constructs a Tile from a SciMLBase DEIntegrator.

Tile(
    @nospecialize(strat::Stratigraphy),
    @nospecialize(discretization_strategy::DiscretizationStrategy),
    @nospecialize(inits::CryoGrid.Initializer...);
    metadata::Dict=Dict(),
    arraytype::Type{A}=Vector,
    iip::Bool=true,
    chunk_size=nothing,
)

Constructs a Tile from the given stratigraphy and discretization strategy. arraytype keyword arg should be an array instance (of any arbitrary length, including zero, contents are ignored) that will determine the array type used for all state vectors.

TileState{TGrid,TStates,Tu,Tt,Tdt}

Represents the state of a CryoGrid Tile.

getstate(tile::Tile, u, du, t, dt=1.0)

Constructs a LayerState representing the full state of layername given tile, state vectors u and du, and the time step t.

getstate(integrator::SciMLBase.DEIntegrator)

Builds the TileState given an initialized integrator.

withaxes(u::AbstractArray, ::Tile)

Constructs a ComponentArray with labeled axes from the given state vector u. Assumes u to be of the same type/shape as setup.uproto.

Convenience macro for defining stratigraphies with multiple subsurface layers.