Seminar 9: PeriLab - Implement your own model

Plain Model

Steps

• choose your model category
• take the template file, rename it and copy it in the model folder
• give you model a name, this name defines how you call your model

function damage_name()
    return "My Model"
end

 Models:
    Damage Models:
      Damage:
        Damage Model: My Model

• Specify your model parameter

 Models:
    Damage Models:
      Damage:
        Damage Model: My Model
        Important value: 200

• get this value in the code

function init_model(datamanager::Module,
                    nodes::AbstractVector{Int64},
                    damage_parameter::Dict,
                    block::Int64)

    println(damage_parameter["Important value"])

    return datamanager
end

• init_model is used to create model specific fields and to check if values, especially optional values exist

function init_model(datamanager::Module,
                    nodes::AbstractVector{Int64},
                    damage_parameter::Dict,
                    block::Int64)
    if !inothing(get(damage_parameter, "Important value", nothing))
        println(damage_parameter["Important value"])
    else
        damage_parameter["Important value"] = 0
    end
    my_constant_node_field = datamanager.create_constant_node_field("my constant node field", Float64, 10)
    my_node_field_N, my_node_field_NP1 = datamanager.create_node_field("my node field", Float64, 2, VectorOrMatrix="Matrix")
    my_constant_bond_field = datamanager.create_constant_bond_field("my constant bond field", Float64, 10)
    my_bobd_field_N,  my_bobd_field_NP1 = datamanager.create_bond_field("my bond field", Float64, 10)

   field = datamanager.create_constant_free_size_field(Fieldname::String, Type_of_variable::Type, size::NTuple)
    fieldN, fieldNP1 = datamanager.create_free_size_field(Fieldname::String, Type_of_variable::Type, size::NTuple)

   my_free_size_field = datamanager.create_constant_free_size_field("my free size field", Bool, (200,1,3,4,1))

    return datamanager
end

• If fields already exist, the field is returned
• Get fields and use them; if you want to now, what fields are already defined and usable

datamanager.get_all_field_keys()

• All node fields can be exported to the result file

function compute_model(datamanager::Module,
                       nodes::AbstractVector{Int64},
                       damage_parameter::Dict,
                       block::Int64,
                       time::Float64,
                       dt::Float64,
                       to::TimerOutput)
    my_constant_field = datamanager.get_field("my constant node field")
    my_field_N = datamanager.get_field("my node field","N")
    my_field_NP1 = datamanager.get_field("my node field","NP1")

    my_field_NP1 .= damage_parameter["Important value"]

    return datamanager
end

• If N and NP1 exist only NP1 will be exported

    Output1:
      Number of Output Steps: 100
      Output File Type: Exodus
      Output Filename: Output_file_name
      Output Variables:
        my node field: true
        my constant node field: true

• Activate the model class. Material is set to true by default. The rest is set to zero.

    Solver:
        Damage Models: true

Run your model

1. create your yaml with all your parameters
2. create a mesh file
3. run the model

using PeriLab
PeriLab.main("Folder where to find your yaml")

Remarks

If you define parameter in your mesh, you can call them in PeriLab as well.

header: x y block_id volume my_values my_datax my_datay

datamanager.get_field("my_values")
datamanager.get_field("my_data")

mydatax and mydatay are a 2D array.