Marker Friction Coefficients

Initialization

EarthBox.Markers.MarkerFriction.initialize! — Function
initialize!(
    model::ModelData; 
    initialization_model::Union{Int, String, Symbol, Nothing}=nothing, kwargs...
)::Nothing

Manage marker friction coefficients initialization and time-dependent models.

Arguments

  • model::ModelData: The model data container containing the model parameters and arrays.
  • initialization_model::Union{Int, String, Symbol, Nothing}:
    • Controls the type of marker friction coefficients initialization model. initialization model for marker friction coefficients. See the Marker Friction Coefficient Initialization Models section below for information on available initialization models. If the initialization_model is not provided, the default initialization model will be used. The initialization model is stored in the model data container as an integer flag (iuse_random_fric). The initialization model parameter flag can be accessed from the model data container as follows:
      • iuse_random_fric = model.materials.parameters.random_friction.iuse_random_fric.value

Keyword Arguments

  • delta_fric_coef::Union{Float64, Nothing}=nothing:
    • Friction coefficient perturbation used to randomize initial marker friction coefficients
  • iuse_random_fric_time::Union{Bool, Nothing}=nothing:
    • Randomize marker friction coefficients with each time step: 0 off; 1 on
  • randomization_factor::Union{Float64, Nothing}=nothing:
    • Randomization factor used to randomize marker friction coefficients with each time step

Marker Friction Initialization Models

Regular

  • initialization_model value: "Regular", :Regular, or 0
  • Description: Initial marker friction is regular.

Randomized

  • initialization_model value: "Randomized", :Randomized, or 1
  • Description: Initial marker friction is randomized using delta_fric_coef.
source