IO - Functions

_init_overlap_map_(size)

Initialize the overlap map.

Arguments

• size::Int64: The number of ranks.

Returns

• overlap_map::Dict{Int64,Dict{Int64,Dict{String,Vector{Int64}}}}: The overlap map.

arc(cmds, dataobject, clockwise::Bool)

G02/G03 arc interpolation with extrusion. Computes points along a circular arc defined by the destination (X, Y) and either the I, J offset of the arc center or the R radius. Follows the same no-E-axis convention as linear.

area_of_polygon(vertices)

Calculate the area of a polygon.

Arguments

• vertices: The vertices of the polygon.

Returns

• area: The area of the polygon.

calculate_block( field_key::String, dof::Int64, calculation_type::String, block::Int64)

Calculate the global value of a field for a given block.

Arguments

• field_key::String: Field key.
• dof::Union{Int64,Vector{Int64}}: Degree of freedom
• calculation_type::String: Calculation type.
• block::Int64: Block number.

Returns

• value::Float64: Global value.
• nnodes::Int64: Number of nodes.

calculate_nodelist(field_key::String, dof::Union{Int64,Vector{Int64}}, calculation_type::String, local_nodes::Vector{Int64})

Calculate the global value of a field for a given set of nodes.

Arguments

• field_key::String: Field key.
• dof::Union{Int64,Vector{Int64}}: Degree of freedom
• calculation_type::String: Calculation type.
• local_nodes::Vector{Int64}: Node set.

Returns

• value::Vector: Global value.
• nnodes::Int64: Number of nodes.

calculate_volume(element_type::String, vertices::Vector{Vector{Float64}})

Calculate the volume of a element.

Arguments

• element_type: The element type of the element.
• vertices: The vertices of the element.

Returns

• volume: The volume of the element.

check_for_duplicate_in_dataframe(mesh::DataFrame)

check duplicated entries and throws an error if one is there. If not everything is ok.

Arguments

• mesh::DataFrame: The input mesh data represented as a DataFrame.

check_mesh_elements(mesh, dof)

Process and analyze mesh data to create an dictionary containing information about mesh elements for further processing.

Arguments

• mesh::DataFrame: The input mesh data represented as a DataFrame.
• dof::Int64: The degrees of freedom (DOF) for the mesh elements.

Returns

A dictionary containing information about mesh elements, which can be used for further processing or uploading.

Example

`julia meshdata = DataFrame(x1 = [1.0, 2.0, 3.0], x2 = [4.0, 5.0, 6.0], volume = [10.0, 20.0, 30.0]) dof = 3 result = checkmeshelements(meshdata, dof)

check_types_in_dataframe(mesh::DataFrame)

check if block_id in mesh contains only int.

Arguments

• mesh::DataFrame: The input mesh data represented as a DataFrame.

clearNP1(name::String)

Clears the NP1 from the name

Arguments

• name::String: The name

Returns

• name::String: The cleared name

close_result_file(result_file::Dict)

Closes the result file

Arguments

• result_file::Dict: The result file

close_result_files(result_files::Vector{Dict}, outputs::Dict{Int64,Dict{}})

Closes the result files if the flush_file flag is not set

Arguments

• result_files::Vector{Dict}: The result files
• outputs::Dict{Int64,Dict{}}: The output settings

close_result_files(result_files::Vector{Dict})

Closes the result files

Arguments

• result_files::Vector{Dict}: The result files

Returns

• true: File is closed
• false: File was already closed

create_and_distribute_bond_norm(comm::MPI.Comm, nlist_filtered_ids::BondScalarState{Int64}, distribution::Vector{Int64}, bond_norm::Vector{Float64}, dof::Int64)

Create and distribute the bond norm

Arguments

• comm::MPI.Comm: MPI communicator
• nlist_filtered_ids::BondScalarState{Int64}: The filtered neighborhood list
• distribution::Vector{Int64}: The distribution
• bond_norm::Vector{Float64}: The bond norm
• dof::Int64: The degree of freedom

create_distribution(nnodes::Int64, size::Int64)

Calculate the initial size of each chunk for a nearly equal number of nodes vs. cores this algorithm might lead to the problem, that the last core is not equally loaded

Arguments

• nnodes::Int64: The number of nodes.
• size::Int64: The number of cores.

Returns

• distribution::Array{Int64,1}: The distribution of the nodes.
• point_to_core::Array{Int64,1}: The number of nodes in each rank.

create_distribution_neighbor_based(nnodes::Int64,nlist::BondScalarState{Int64}, size::Int64)

Calculate the initial size of each chunk for a nearly equal number of nodes vs. cores this algorithm might lead to the problem, that the last core is not equally loaded

Arguments

• nnodes::Int64: The number of nodes.
• nlist::BondScalarState{Int64}: The neighborhood list.
• size::Int64: The number of cores.

Returns

• distribution::Array{Int64,1}: The distribution of the nodes.
• point_to_core::Array{Int64,1}: The number of nodes in each rank.

create_distribution_node_based(nnodes::Int64,nlist::BondScalarState{Int64}, size::Int64)

Calculate the initial size of each chunk for a nearly equal number of nodes vs. cores this algorithm might lead to the problem, that the last core is not equally loaded

Arguments

• nnodes::Int64: The number of nodes.
• nlist::BondScalarState{Int64}: The neighborhood list.
• size::Int64: The number of cores.

Returns

• distribution::Array{Int64,1}: The distribution of the nodes.
• point_to_core::Array{Int64,1}: The number of nodes in each rank.

glob_to_loc(distribution)

Get the global to local mapping

Arguments

• distribution: The distribution

Returns

• create_global_to_local_mapping: The global to local mapping

create_neighborhoodlist(mesh::DataFrame, params::Dict, dof::Int64)

Create the neighborhood list of the mesh elements.

Arguments

• mesh::DataFrame: The input mesh data represented as a DataFrame.
• params::Dict: The input parameters.
• dof::Int64: The degrees of freedom (DOF) for the mesh elements.

Returns

• nlist::Array{Array{Int64,1},1}: The neighborhood list of the mesh elements.

create_overlap_map(distribution, ptc, size)

Create the overlap map.

Arguments

• distribution::Array{Int64,1}: The distribution of the nodes.
• ptc::Array{Int64,1}: The number of nodes in each rank.
• size::Int64: The number of ranks.

Returns

• overlap_map::Dict{Int64,Dict{Int64,Dict{String,Vector{Int64}}}}: The overlap map.

create_result_file(filename::Union{AbstractString,String}, num_nodes::Int64, num_dim::Int64, num_elem_blks::Int64, num_node_sets::Int64)

Creates a exodus file for the results

Arguments

• filename::Union{AbstractString,String}: The name of the file to create
• num_nodes::Int64: The number of nodes
• num_dim::Int64: The number of dimensions
• num_elem_blks::Int64: The number of element blocks
• num_node_sets::Int64: The number of node sets

Returns

• result_file::Dict{String,Any}: A dictionary containing the filename and the exodus file

create_result_file(filename::String, outputs::Dict)

Creates a csv file for the results

Arguments

• filename::String: The name of the file to create
• outputs::Dict: The outputs dictionary

Returns

• Dict: The result file

csv_reader(filename::String)

Read csv and return it as a DataFrame.

Arguments

• filename::String: The path to the mesh file.

Returns

• csvData::DataFrame: The csv data a DataFrame.

define_nsets(nsets::Dict{String,Vector{Int64}})

Defines the node sets

Arguments

• nsets::Dict{String,Vector{Int64}}: Node sets read from files

delete_files(result_files::Vector{Dict})

Deletes the result files

Arguments

• result_files: The result files

distribute_neighborhoodlist_to_cores(comm::MPI.Comm, nlist, distribution)

Distributes the neighborhood list to the cores.

Arguments

• comm::MPI.Comm: MPI communicator
• nlist: neighborhood list
• distribution Array{Int64}: global nodes distribution at cores

distribution_to_cores(comm::MPI.Comm, mesh, distribution, dof::Int64)

Distributes the mesh data to the cores

Arguments

• comm::MPI.Comm: MPI communicator
• mesh: Mesh
• distribution Array{Int64}: global nodes distribution at cores
• dof::Int64: Degree of freedom

element_distribution(topology::Vector{Vector{Int64}}, ptc::Vector{Int64}, size::Int64)

Create the distribution of the finite elements. Is needed to avoid multiple element calls. Each element should run only one time at the cores.

Arguments

• topology::Vector{Vector{Int64}}: The topology list of the mesh elements.
• nlist::BondScalarState{Int64}: The neighborhood list of the mesh elements.
• size::Int64: The number of ranks.

Returns

• distribution::Vector{Vector{Int64}}: The distribution of the nodes.
• etc::Vector{Int64}: The number of nodes in each rank.

extrude_surface_mesh(mesh::DataFrame)

extrude the mesh at the surface of the block

Arguments

• mesh::DataFrame: The input mesh data represented as a DataFrame.
• params::Dict: The input parameters.

find_global_core_value!(global_value::Union{Int64,Float64}, calculation_type::String, nnodes::Int64)

Find global core value.

Arguments

• global_value::Union{Int64,Float64}: The global value
• calculation_type::String: The calculation type
• nnodes::Int64: The number of nodes

Returns

• global_value::Union{Int64,Float64}: The global value

get_block_nodes(block_Id::AbstractVector{Int64}, block::Int64)

Returns the nodes of a block

Arguments

• block_Id::AbstractVector{Int64}: The block Id
• block::Int64: The block

Returns

• nodes::Vector{Int64}: The nodes of the block

get_bond_geometry()

Gets the bond geometry

get_file_size(result_files::Vector{Dict})

Gets the file size of the result files

Arguments

• result_files: The result files

Returns

• total_file_size: The total file size

get_global_values(output::Dict,)

Get global values.

Arguments

• output::Dict: The output

Returns

• global_values::Vector: The global values

get_local_element_topology(topology::Vector{Vector{Int64}}, distribution::Vector{Int64})

Get the local element topology

Arguments

• topology::Vector{Vector{Int64}}: The topology
• distribution::Vector{Int64}: The distribution

get_local_neighbors(mapping, nlist_core)

Gets the local neighborhood list from the global neighborhood list

Arguments

• mapping: mapping function
• nlist_core: global neighborhood list

Returns

• nlist_core: local neighborhood list

get_local_overlap_map()

Changes entries in the overlap map from the global numbering to the local computer core one.

Arguments

• overlap_map::Dict{Int64, Dict{Int64, String}}: overlap map with global nodes.
• distribution::Vector{Vector{Int64}}: global nodes distribution at cores, needed for the gobal to local mapping
• ranks Array{Int64} : number of used computer cores

Returns

• overlap_map::Dict{Int64, Dict{Int64, String}}: returns overlap map with local nodes.

Example:

get_local_overlap_map(overlap_map, distribution, ranks)  # returns local nodes

get_mpi_rank_string(rank::Int64, max_rank::Int64)

Get MPI rank string.

Arguments

• value::Int64: The rank
• max_rank::Int64: The max rank

Returns

• result::String: The result

get_number_of_neighbornodes(nlist::BondScalarState{Int64})

Get the number of neighbors for each node.

Arguments

• nlist::BondScalarState{Int64}: The neighborhood list of the mesh elements.

Returns

• length_nlist::Vector{Int64}: The number of neighbors for each node.

get_paraview_coordinates(dof::Int64, refDof::Int64)

Returns the paraview specific dof

Arguments

• dof::Int64: The degrees of freedom
• refDof::Int64: The reference degrees of freedom

Returns

• paraview_specifics::String: The paraview specific dof

get_results_mapping(params::Dict, path::String)

Gets the results mapping

Arguments

• params::Dict: The parameters
• path::String: The path

Returns

• output_mapping::Dict{Int64,Dict{}}: The results mapping

global_value_avg(field::Union{NodeScalarField{Float64},NodeVectorField{Float64}}, dof::Union{Int64,Vector{Int64}}, nodes::AbstractVector{Int64})

Calculate the global average of a field for given nodes.

Arguments

• field::Union{NodeScalarField{Float64},NodeVectorField{Float64}}: Field.
• dof::Union{Int64,Vector{Int64}}: Degree of freedom
• nodes::AbstractVector{Int64}: Nodes.

Returns

• returnValue::Vector: Global value.

global_value_max(field::Union{NodeScalarField{Float64},NodeVectorField{Float64}}, dof::Union{Int64,Vector{Int64}}, nodes::AbstractVector{Int64})

Calculate the global maximum of a field for given nodes.

Arguments

• field::Union{NodeScalarField{Float64},NodeVectorField{Float64}}: Field.
• dof::Union{Int64,Vector{Int64}}: Degree of freedom
• nodes::AbstractVector{Int64}: Nodes.

Returns

• returnValue::Vector: Global value.

global_value_min(field::Union{NodeScalarField{Float64},NodeVectorField{Float64}}, dof::Union{Int64,Vector{Int64}}, nodes::AbstractVector{Int64})

Calculate the global minimum of a field for given nodes.

Arguments

• field::Union{NodeScalarField{Float64},NodeVectorField{Float64}}: Field.
• dof::Union{Int64,Vector{Int64}}: Degree of freedom
• nodes::AbstractVector{Int64}: Nodes.

Returns

• returnValue::Vector: Global value.

global_value_sum(field::Union{NodeScalarField{Float64},NodeVectorField{Float64},NodeTensorField{Float64}}, dof::Union{Int64,Vector{Int64}}, nodes::AbstractVector{Int64})

Calculate the global sum of a field for given nodes.

Arguments

• field::Union{NodeScalarField{Float64},NodeVectorField{Float64},NodeTensorField{Float64}}: Field.
• dof::Union{Int64,Vector{Int64}: Degree of freedom
• nodes::AbstractVector{Int64}: Nodes.

Returns

• returnValue::Vector: Global value.

hex8volume(hexvertices)

Calculate the volume of a hex.

Arguments

• hex_vertices: The vertices of the wedge.

Returns

• volume: The volume of the wedge.

hex8volume(hexvertices)

Calculate the volume of a hex.

Arguments

• hex_vertices: The vertices of the wedge.

Returns

• volume: The volume of the wedge.

init_data(params::Dict, path::String, comm::MPI.Comm)

Initializes the data for the mesh.

Arguments

• params::Dict: The parameters for the simulation.
• path::String: The path to the mesh file.
• comm::MPI.Comm: The MPI communicator.

Returns

• params::Dict: The parameters for the simulation.

init_orientations()

Initialize orientations.

init_results_in_exodus(exo::ExodusDatabase, output::Dict{}, coords::Union{Matrix{Int64},Matrix{Float64}}, block_Id::Vector{Int64}, block_list::Vector{String}, nsets::Dict{String,Vector{Int64}}, global_ids::Vector{Int64}, PERILAB_VERSION::String)

Initializes the results in exodus

Arguments

• exo::ExodusDatabase: The exodus database
• output::Dict{String,Any}: The output
• coords::Union{Matrix{Int64},Matrix{Float64}}: The coordinates
• block_Id::Vector{Int64}: The block Id
• block_list::Vector{String}: The unique blocks
• nsets::Dict{String,Vector{Int64}}: The node sets
• global_ids::Vector{Int64}: The global ids

Returns

• result_file::Dict{String,Any}: The result file

init_write_results(params::Dict, output_dir::String, path::String, nsteps::Int64, PERILAB_VERSION::String)

Initialize write results.

Arguments

• params::Dict: The parameters
• output_dir::String: The output directory.
• path::String: The path
• nsteps::Int64: The number of steps

Returns

• result_files::Array: The result files
• outputs::Dict: The outputs

initialize_data(filename::String, filedirectory::String, comm::MPI.Comm)

Initialize data.

Arguments

• filename::String: The name of the input file.
• filedirectory::String: The directory of the input file.
• comm::MPI.Comm: The MPI communicator

Returns

• data::Dict: The data

linear(cmds, dataobject)

Example extrusion callback for G1 which calculates total length of filament extruded.

The extruded filament length is obtained by watching the E axis movement in the g-code file. If no E axis is present anywhere in the file, G1 moves are treated as material deposition/cutting moves by convention (only G0 is a pure travel move).

load_and_evaluate_mesh(params::Dict, path::String, ranksize::Int64)

Load and evaluate the mesh data.

Arguments

• params::Dict: The input parameters.
• path::String: The path to the mesh file.
• ranksize::Int64: The number of ranks.

Returns

• distribution::Array{Int64,1}: The distribution of the mesh elements.
• mesh::DataFrame: The mesh data as a DataFrame.
• ntype::Dict: The type of the mesh elements.
• overlap_map::Array{Array{Int64,1},1}: The overlap map of the mesh elements.
• nlist::Array{Array{Int64,1},1}: The neighborhood list of the mesh elements.
• dof::Int64: The degrees of freedom (DOF) for the mesh elements.
• nsets::Dict: The node sets
• topology::Int64::Array{Int64,nelement:nodes}`: The topology of elements.
• el_distribution::Array{Int64,1}: The distribution of the finite elements.

local_nodes_from_dict(create_global_to_local_mapping::Dict{Int,Int}, global_nodes::Vector{Int64})

Changes entries in the overlap map from the global numbering to the local computer core one.

Arguments

• create_global_to_local_mapping::Dict{Int,Int}: global to local mapping
• global_nodes::Vector{Int64}: global nodes

Returns

• overlap_map::Dict{Int64, Dict{Int64, String}}: returns overlap map with local nodes.

merge_exodus_file(file_name::Union{AbstractString,String})

Merges the exodus file

Arguments

• file_name::Union{AbstractString,String}: The name of the file to merge

Returns

• exo::ExodusDatabase: The exodus file

merge_exodus_files(result_files::Vector{Any}, output_dir::String)

Merges exodus output files

Arguments

• result_files::Vector{Any}: The result files
• output_dir::String: The file directory

movement(cmds, dataobject)

Example movement callback for G0 and G1 which calculates the total distance moved in all axes.

It is calculated by watching the X, Y and Z axes movement.

neighbors(mesh, params::Dict, coor)

Compute the neighbor list for each node in a mesh based on their proximity using a BallTree data structure.

Arguments

• mesh: A mesh data structure containing the coordinates and other information.
• params: paramss needed for computing the neighbor list.
• coor: A vector of coordinate names along which to compute the neighbor list.

Returns

An array of neighbor lists, where each element represents the neighbors of a node in the mesh.

node_distribution(nlist::BondScalarState{Int64}, size::Int64)

Create the distribution of the nodes.

Arguments

• nlist::BondScalarState{Int64}: The neighborhood list of the mesh elements.
• size::Int64: The number of ranks.
• distribution_type::String: The distribution type.

Returns

• distribution::Vector{Vector{Int64}}: The distribution of the nodes.
• ptc::Vector{Int64}: Defines at which core / rank each node lies.
• ntype::Dict: The type of the nodes.

open_result_file(result_file::Dict)

Opens the result file

Arguments

• result_file::Dict: The result file

paraview_specifics(dof::Int64)

Returns the paraview specific dof

Arguments

• dof::Int64: The degrees of freedom

Returns

• paraview_specifics::String: The paraview specific dof

parseLine(line::String, returnPair::Bool = true)::Array{Union{String,Pair{String,String}},1}

Parse a single line of g-code and return an array of Pair{String,String} or an array of String containing the parsed commands.

The first command usually defines what to do (ie. G01 - linear interpolation) and following commands are the arguments (ie. X 14.312);

Examples

julia> parseLine("G10 X5.Y3. E6.")
4-element Array{Union{Pair{String,String}, String},1}:
 "G" => "10"
 "X" => "5."
 "Y" => "3."
 "E" => "6."

Return array of strings

julia> parseLine("G10 X5.Y3. E6.", false)
4-element Array{Union{Pair{String,String}, String},1}:
 "G10"
 "X5."
 "Y3."
 "E6."

read_external_topology(filename::String)

Read external topoloy data from a file and return it as a DataFrame.

Arguments

• filename::String: The path to the mesh file.

Returns

• external_topology::DataFrame: The external topology data as a DataFrame.

read_input(filename::String)

Reads the input deck from a yaml file

Arguments

• filename::String: The name of the yaml file

Returns

• params::Dict{String,Any}: The parameters read from the yaml file

read_input_file(filename::String)

Reads the input deck from a yaml file

Arguments

• filename::String: The name of the yaml file

Returns

• Dict{String,Any}: The validated parameters read from the yaml file.

read_mesh(filename::String, params::Dict)

Read mesh data from a file and return it as a DataFrame.

Arguments

• filename::String: The path to the mesh file.
• params::Dict: The input parameters.

Returns

• mesh::DataFrame: The mesh data as a DataFrame.

set_angles(params::Dict, block_nodes::Dict)

Sets the density of the nodes in the dictionary.

Arguments

• params::Dict: The parameters
• block_nodes::Dict: A dictionary mapping block IDs to collections of nodes

set_dof(mesh::DataFrame)

Set the degrees of freedom (DOF) for the mesh elements.

Arguments

• mesh::DataFrame: The input mesh data represented as a DataFrame.

Returns

• dof::Int64: The degrees of freedom (DOF) for the mesh elements.

set_output_frequency(params::Dict, nsteps::Int64, step_id::Int64)

Sets the output frequency.

Arguments

• params::Dict: The parameters
• nsteps::Int64: The number of steps
• step_id::Int64: The step id

show_block_summary(solver_options::Dict, params::Dict, log_file::String, silent::Bool, comm::MPI.Comm)

Show block summary.

Arguments

• solver_options::Dict: The solver options
• params::Dict: The params
• log_file::String: The log file
• silent::Bool: The silent flag
• comm::MPI.Comm: The Comm_rank

show_mpi_summary(log_file::String, silent::Bool, comm::MPI.Comm)

Show MPI summary.

Arguments

• log_file::String: The log file
• silent::Bool: The silent flag
• comm::MPI.Comm: The comm

stripComments(line::String)::String

Return a copy of string line with stripped comments inside parentheses and all characters after a semicolon.

This function also removes whitespace as it it not needed for further parsing.

Examples

julia> stripComments("G92 (G10(aaa)))) ((comment)G) Z0.2 ; this is a comment")
"G92Z0.2"

tetrahedron_volume(tet_vertices)

Calculate the volume of a tetrahedron.

Arguments

• tet_vertices: The vertices of the tetrahedron.

Returns

• volume: The volume of the tetrahedron.

tetrahedron_volume(tet_vertices)

Calculate the volume of a tetrahedron.

Arguments

• tet_vertices: The vertices of the tetrahedron.

Returns

• volume: The volume of the tetrahedron.

wedge6_volume(wedge_vertices)

Calculate the volume of a wedge.

Arguments

• wedge_vertices: The vertices of the wedge.

Returns

• volume: The volume of the wedge.

write_global_results_in_csv(csv_file::IOStream, time::Float64, global_values)

Writes the global results to the csv file

Arguments

• csv_file::IOStream: The csv file
• global_values: The global values

write_global_results_in_exodus(exo::ExodusDatabase, step::Int64, global_values)

Writes the global results in the exodus file

Arguments

• exo::ExodusDatabase: The exodus file
• step::Int64: The step
• global_values: The global values

Returns

• exo::ExodusDatabase: The exodus file

write_nodal_results_in_exodus(exo::ExodusDatabase, step::Int64, output::Dict)

Writes the nodal results in the exodus file

Arguments

• exo::ExodusDatabase: The exodus file
• step::Int64: The step
• output::Dict: The output

Returns

• exo::ExodusDatabase: The exodus file

write_pd_mesh_arc(dataobject, sx, sy, sz, ex, ey, ez)

Variant of write_pd_mesh for arc segments. Uses the provided start/end points instead of reading them from dataobject.

write_results(result_files::Vector{Any}, time::Float64, max_damage::Float64, outputs::Dict)

Write results.

Arguments

• result_files::Vector{Any}: The result files
• time::Float64: The time
• max_damage::Float64: The maximum damage
• outputs::Dict: The outputs

Returns

• result_files::Vector{Any}: The result files

write_step_and_time(exo::ExodusDatabase, step::Int64, time::Float64)

Writes the step and time in the exodus file

Arguments

• exo::ExodusDatabase: The exodus file
• step::Int64: The step
• time::Float64: The time

Returns

• exo::ExodusDatabase: The exodus file

_get_values(params::Dict, block_id::Int64, valueName::String, defaultValue::Union{Float64,Bool,Nothing})

Get the value of a block.

Arguments

• params::Dict: The parameters
• block_id::Int64: The ID of the block
• valueName::String: The name of the value
• defaultValue::Union{Float64,Bool,Nothing: The default value

Returns

• value::Float64: The value of the block

check_for_duplicates(filenames)

Check for duplicate filenames.

Arguments

• filenames::Vector{String}: The filenames

get_all_keys(params::Dict)

Get all the keys in the parameters

Arguments

• params::Dict: The parameters dictionary.

Returns

• keys_list::Array: The keys list

get_angles(params::Dict, block_id::Int64, dof::Int64)

Get the horizon of a block.

Arguments

• params::Dict: The parameters
• block_id::Int64: The ID of the block
• dof::Int64: The dof

Returns

• angles::Float64: The angles of the block

get_bc_definitions(params::Dict)

Get the boundary condition definitions

Arguments

• params::Dict: The parameters

Returns

• bcs::Dict{String,Any}: The boundary conditions

get_block_names_and_ids(params::Dict, block_ids::Vector{Int64})

Get the names of the blocks.

Arguments

• params::Dict: The parameters dictionary.
• block_ids::Vector{Int64}: The IDs of the blocks

Returns

• block_names::Vector{String}: The names of the blocks.

get_bond_filters(params::Dict)

Returns the bond filters from the parameters

Arguments

• params::Dict: The parameters

Returns

• check::Bool: Whether the bond filters are defined
• bfList::Dict{String,Dict{String,Any}}: The bond filters

get_calculation_options(params::Dict)

Get the calculation options

Arguments

• params::Dict: The parameters dictionary.

Returns

• solver_options::Dict: The solver options

get_computes(params::Dict, variables::Vector{String})

Get the computes.

Arguments

• params::Dict: The parameters dictionary.
• variables::Vector{String}: The variables.

Returns

• computes::Dict{String,Dict{Any,Any}}: The computes.

get_computes_names(params::Dict)

Get the names of the computes.

Arguments

• params::Dict: The parameters dictionary.

Returns

• computes_names::Vector{String}: The names of the computes.

get_density(params::Dict, block_id::Int64)

Get the density of a block.

Arguments

• params::Dict: The parameters
• block_id::Int64: The ID of the block

Returns

• density::Float64: The density of the block

get_end_time(outputs::Dict, output::String)

Get the end_time.

Arguments

• outputs::Dict: The outputs
• output::String: The output

Returns

• end_time::Float64: The value

get_external_topology_name(params::Dict, path)

Returns the name of the mesh file from the parameters

Arguments

• params::Dict: The parameters
• path::String: Path of the working folder

Returns

• String: The name of the finite element topology file

get_fem_block(params::Dict, block_id::Int64)

Get the fem_block of a block.

Arguments

• params::Dict: The parameters
• block_id::Int64: The ID of the block

Returns

• fem_block::Float64: The fem_block of the block

get_final_time(params::Dict)

Get the final time

Arguments

• params::Dict: The parameters dictionary.

Returns

• final_time::Float64: The final time

get_fixed_dt(params::Dict)

Get the fixed time step

Arguments

• params::Dict: The parameters dictionary.

Returns

• fixed_dt::Float64: The fixed time step

get_flush_file(outputs::Dict, output::String)

Gets the flush file.

Arguments

• outputs::Dict: The outputs
• output::String: The output

Returns

• flush_file::Bool: The flush file

get_header(filename::Union{String,AbstractString})

Returns the header line and the header.

Arguments

• filename::Union{String,AbstractString}: The filename of the file.

Returns

• header_line::Int: The header line.
• header::Vector{String}: The header.

get_heat_capacity(params::Dict, block_id::Int64)

Get the heat capacity of a block.

Arguments

• params::Dict: The parameters
• block_id::Int64: The ID of the block

Returns

• heat_capacity::Float64: The heat capacity of the block

get_horizon(params::Dict, block_id::Int64)

Get the horizon of a block.

Arguments

• params::Dict: The parameters
• block_id::Int64: The ID of the block

Returns

• horizon::Float64: The horizon of the block

get_initial_time(params::Dict)

Get the initial time

Arguments

• params::Dict: The parameters dictionary.

Returns

• initial_time::Float64: The initial time

getmaxdamage(params::Dict)

Get the maximum damage.

Arguments

• params::Dict: The parameters dictionary.

Returns

• max_damage::Float64: The value

get_mesh_name(params::Dict)

Returns the name of the mesh file from the parameters

Arguments

• params::Dict: The parameters

Returns

• String: The name of the mesh file

get_model_options(params::Dict)

Get the solver options

Arguments

• params::Dict: The parameters dictionary.

Returns

• solver_options::Dict: The solver options

get_model_parameter(params, model, id)

Retrieve a model parameter from a dictionary of parameters.

This function retrieves a specific model parameter from a dictionary of parameters based on the provided model and identifier (id).

Arguments

• params::Dict: A dictionary containing various parameters.

• model::String: The model type for which the parameter is sought.

• id::String: The identifier (name) of the specific model parameter.

Returns

• parameter::Any: The retrieved model parameter, or nothing if the parameter is not found.

Errors

• If the specified model is defined in blocks but no model definition block exists, an error message is logged, and the function returns nothing.

• If the model with the given identifier is defined in blocks but missing in the model's definition, an error message is logged, and the function returns nothing.

Example

params = Dict(
    "Models" => Dict(
        "Models" => Dict(
            "ModelA" => 42,
            "ModelB" => 24
        )
    )
)

model = "Models"
id = "ModelA"

result = get_model_parameter(params, model, id)
if result !== nothing
    println("Parameter id: result")
else
    println("Parameter not found.")
end

get_node_sets(params::Dict, path::String)

Returns the node sets from the parameters

Arguments

• params::Dict: The parameters
• path::String: The path to the mesh file

Returns

• nsets::Dict{String,Any}: The node sets

get_nsteps(params::Dict)

Get the fixed time step

Arguments

• params::Dict: The parameters dictionary.

Returns

• nsteps::Int64: The fixed time step

get_numerical_damping(params::Dict)

Get the numerical damping

Arguments

• params::Dict: The parameters dictionary.

Returns

• numerical_damping::Float64: The numerical damping

get_output_fieldnames(outputs::Dict, variables::Vector{String}, computes::Vector{String}, output_type::String)

Gets the output fieldnames.

Arguments

• outputs::Dict: The outputs
• variables::Vector{String}: The variables
• computes::Vector{String}: The computes
• output_type::String: The output type

Returns

• output_fieldnames::Vector{String}: The output fieldnames

get_output_filenames(params::Dict, output_dir::String)

Gets the output filenames.

Arguments

• params::Dict: The parameters
• output_dir::String: The file directory

Returns

• filenames::Vector{String}: The filenames

get_output_frequencies(params::Dict, nsteps::Int64)

Gets the output frequencies.

Arguments

• params::Dict: The parameters
• nsteps::Int64: The number of steps

Returns

• freq::Vector{Int64}: The output frequencies

get_output_type(outputs::Dict, output::String)

Gets the output type.

Arguments

• outputs::Dict: The outputs
• output::String: The output

Returns

• output_type::String: The output type

get_output_variables(output::String, variables::Vector{String})

Get the output variable.

Arguments

• output::String: The output variable.
• variables::Vector{String}: The variables.

Returns

• output::String: The output variable.

get_outputs(params::Dict, variables::Vector{String}, compute_names::Vector{String})

Gets the outputs.

Arguments

• params::Dict: The parameters
• variables::Vector{String}: The variables
• compute_names::Vector{String}: The compute names

Returns

• outputs::Dict: The outputs

get_safety_factor(params::Dict)

Get the safety factor

Arguments

• params::Dict: The parameters dictionary.

Returns

• safety_factor::Float64: The safety factor

get_solver_name(params::Dict)

Get the name of the solver

Arguments

• params::Dict: The parameters dictionary.

Returns

• solver_name::String: The name of the solver

get_solver_params(params::Dict)

Get the solver parameters

Arguments

• params::Dict: The parameters dictionary.

Returns

• solver_params::Dict: The solver parameters

get_solver_steps(params::Dict)

Get the solver steps

Arguments

• params::Dict: The parameters dictionary.

Returns

• solver_steps::List: The solver steps

get_start_time(outputs::Dict, output::String)

Get the start_time.

Arguments

• outputs::Dict: The outputs
• output::String: The output

Returns

• start_time::Float64: The value

get_write_after_damage(outputs::Dict, output::String)

Get the write after damage.

Arguments

• outputs::Dict: The outputs
• output::String: The output

Returns

• write_after_damage::Bool: The value

validate_structure_recursive(expected::Dict, actual::Dict, validate::Bool, checked_keys::Array, path::String="")

Validates the parameters against the expected structure

Arguments

• expected::Dict: The expected structure
• actual::Dict: The actual structure
• validate::Bool: The validation results
• checked_keys::Array: The keys that have been checked
• path::String: The current path

Returns

• validate::Bool: The validation result
• checked_keys::Array: The keys that have been checked

validate_yaml(params::Dict)

Validates the parameters against the expected structure

Arguments

• params::Dict: The parameters dictionary.

Returns

• params::Dict: The parameters dictionary.