Advanced API Introduction

This section covers the reference documentation for all things not included in the main API, split into the package's modules. The first part of each modules documentation contains the documentation for the external 'advanced' API, these are things that are intended for use to extend customise simulations beyond the default behaviour. The second part are the internal functions not intended for external use.

The external APIs are exported by their module, but not exported by the package, so to use them you will need to either use their full address:

julia> using HSSSimulations
julia> Solver.loadSetSolver!loadSetSolver! (generic function with 2 methods)

or by using the module it is in:

julia> using HSSSimulations
julia> using .Solver
julia> loadSetSolver!loadSetSolver! (generic function with 2 methods)

Modules

• Types
• • External
  • Internal
• Simulation Results
• • Time/Load Step Results
  • End of Simulation Results
• Material Model
• • PA2200
  • New Materials Using the Default Model
  • Modifying the Current Material Model
  • Making a New Material Model
• Boundary Model
• • Parameters
  • Load Sets
  • Loads
  • Boundary
  • Utilities
  • Internals
• HSS Boundary
• • Parameters
  • No Carriage Loads
  • Carriage Loads
  • Utilities
• Solver
• • Internal
• Post Processing
• • External
  • Internal