Documentation

• Input file syntax
  • parseInputFile()
  • keywordIdentifier
  • Keywords
• The input system: how .inp grammar is defined
  • The four layers
  • L2: declaring a schema
  • L3: the registry
  • L4: from parsed text to a Python call
  • Top-level keywords
  • Dynamic >>options overrides
  • Documentation and the grammar surface come from the same schema
  • Worked example: adding a new output manager
  • Quick reference
• Inputfile driven simulations
  • finiteElementSimulation()
• Models
  • FEModel - A classical finite element model
  • EquationSystemLayout - What the equation system of a model is made of
  • TopologyPipeline - How the mesh may change during a run
• Solvers
  • getSolverByName()
  • The residual and the tangent
  • What the solver asks the model
  • NIST - Nonlinear Implicit Static
  • NISTParallel - Nonlinear Implicit Static (parallel)
  • NISTPArcLength - Nonlinear Implicit Static - Arc length
  • NID - Nonlinear Implicit Dynamic (Newmark-beta)
  • NIDParallel - Nonlinear Implicit Dynamic (Newmark-beta, parallel)
  • Prediction of an increment in the implicit solvers
  • Line search and quasi-Newton fallback of the implicit solvers
  • Convergence criteria of the implicit solvers
  • Iteration table of the implicit solvers
  • Performance table of the implicit solvers
  • NEST - Nonlinear Explicit Static
  • NESTParallel - Nonlinear Explicit Static (parallel)
  • NED - Nonlinear Explicit Dynamic
  • NEDParallel - Nonlinear Explicit Dynamic (parallel)
• Linear solvers
  • Direct or iterative
  • One adapter for every type
  • The options of each type
  • The pages on linear solvers
• Steps
  • StepBase
  • StepIncrementationSchema
  • Increment control of adaptive steps
  • Falling back to a restart checkpoint
  • AdaptiveStep - A classical adpative step for transient simulations
  • AdaptiveStepForExplicitSimulations - An adaptive step for explicit simulations
• Analytical fields
  • scalarexpression - Field defined by expression
  • randomscalar - A random field
  • fromvtk - Field interpolated from VTK data
  • Implementing your own fields
• Constraints
  • equalvaluelagrangian - Constrain nodal values to equal values
  • equalvaluepenalty - Constrain nodal values to equal values
  • linearizedrigidbody - Linearized rigid body constraints
  • linearizedrigidbodympc - Linearized rigid body constraints by DOF elimination
  • rigidbody - Geometrically exact rigid body constraints in 3D
  • penaltyindirectcontrol - Penalty based indirect control
  • directionalspringpenalty - Assigning a stiffness to specific degrees of freedom
  • nodetorigidsurfacepenalty - Preventing nodes from penetrating a defined rigid boundary
  • nodetodiscreterigidbodypenalty - Contact against a discrete rigid body (deprecated)
  • nodetodeformablesurfacepenalty - Node-to-deformable-surface contact
  • surfacetodeformablesurfacepenalty - Integrated surface-to-surface contact
  • surfacetodiscreterigidbodypenalty - Integrated contact against a discrete rigid body
  • tie - Surface-to-surface tie (DOF elimination)
  • Contested slave degrees of freedom
  • Multi-point constraints and Dirichlet boundary conditions
  • hangingnode - Hanging-node coupling for adaptive mesh refinement
  • Implementing your own constraints
• Rigid bodies
  • Kinematics
  • Mass properties
  • Surface query
  • Creating a discrete rigid body
  • API
• Contact mechanics: theory
  • Formulation
  • Surface discretization and load transfer
  • Framework integration and verification
• Degree of Freedom (DOF) Manager and Numerics
  • DofManager
  • DofVector
  • ScatterDofVector
  • VIJSystemMatrix
  • VIJEntityBase
  • Parallelization Utilities
• System matrix assembly
  • The two paths
  • In the implicit solvers
  • Why the direct path is also faster
  • The one definition of the pattern
  • Building only the pattern
  • One CSR array, atomic additions
  • Validation
  • Reference
• Field outputs
  • FieldOutputController
  • _FieldOutputBase
  • ElementFieldOutput
  • NodeFieldOutput
  • RigidBodyFieldOutput
  • ExpressionFieldOutput
• Fields
  • NodeField - A physical field on nodes
• Node field results
  • Who owns what
  • The entries
  • Models whose equation system covers a part of their nodes
  • Using the entries in code
  • Where the solvers do not follow this page yet
• Elements
  • getElementClass()
  • Provider marmot
  • Provider marmotsingleqpelement
  • Provider edelweiss
  • Contact facet elements
  • Implementing your own elements
• Exceptions
  • ConditionalStop
  • CutbackRequest
  • DivergingSolution
  • IncrementFailed
  • InputExecption
  • MeshChangedSinceCheckpoint
  • ReachedMaxIncrements
  • ReachedMaxIterations
  • ReachedMinIncrementSize
  • RestartError
  • StepFailed
  • TopologyError
  • WrongDomain
• Generators
  • boxgen - A 3D box mesh generator
  • planerectquad - A 2D plane rectangular mesh generator
  • pipegen - A 3D pipe mesh generator
  • cubit - A cubit mesh generator
  • findclosestnode - Find the closest node
  • cylindergenerator - A structured hex mesh generator for cylindrical geometries
  • cuboidlatticegenerator - A cuboid lattice mesh generator
  • microstructuregenerator - A unit-cell-based microstructure mesh generator
  • discreterigidbodygenerator - A discrete rigid body from a surface mesh file
  • executepythoncode - Script model generation using Python
  • surfaceElementGenerator - Contact facet elements from a *surface
• Journal
  • Journal
  • displayWidth()
• Materials
  • Provider marmotmaterial
  • Provider edelweiss (Materials)
• Creating finite element meshes
• Model modifiers
  • hAdaptivity - Hanging-node h-adaptivity for HEX20
  • Batching refinement across increments
  • State-variable transfer strategies
  • Predictor after a refinement
  • Re-equilibration after a refinement
  • Refinement under a dynamic solver
  • Compatibility with facet-based contact and tie
  • Transparency for ordinary (AMR-unaware) consumers
  • surfaceSnap - Analytical-surface node snapping for AMR-refined curved boundaries
  • Restart / checkpointing
  • Implementing your own model modifiers
• The topology pipeline: how a model changes itself
  • One increment, three phases
  • Writing a model modifier: plan and apply
  • Why the split exists: restart
  • Element and node numbers
  • Reacting to a change: three tiers, deliberately
  • Why pull, and not a push notification
  • A checklist for a new modifier
• Restart
  • The rule
  • One increment, and where the checkpoint is written
  • Restoring a checkpoint
  • Going back to a checkpoint within a run
  • Adding something that carries state between increments
• Adaptive refinement: error estimation and marking
  • The adaptive loop and where markers sit
  • Motivation: gradient-enhanced damage
  • Recovery-based a posteriori error estimation
  • Marking: which of the ranked elements to refine
  • Reactive and predictive marking: why more than one marker
  • Usage
  • Implementation
  • Limitations and extensions
  • References
• Outputmanagers
  • ensight - Export to Ensight Gold format
  • monitor - Monitor quantities in the terminal
  • meshplot - Export to matplotlib
  • fractureenergyintegrator - Determine the fracture energy
  • plotalongpath - Plot a result along a line
  • conditionalstop - Conditional stop if expression becomes true
  • statusfile - Write the status of the simulation to a file
  • meshdatatofile - Write the (generated) mesh data to a file
  • computetimemonitor - Print and write compute times per increment
  • restart - Write restart checkpoints during the analysis
• Parallelization
  • Array operations on the thread pool
  • Do not set OMP_PROC_BIND or OMP_PLACES
  • Thread-local buffers in the element loop
  • Load balancing of the element loop
• Physical phenomena
  • carriesKineticEnergy()
  • carriesLinearMomentum()
  • getInertiaKind()
• Plotting
  • Plotter
• Points
  • Node
• Sections
• Sets
  • ImmutableOrderedSet
  • OrderedSet
  • NodeSet
  • ElementSet
• Step actions
  • bodyforce - Bodyforce loads
  • dirichlet - Standard dirichlet BC
  • distributedload - Distributed surface loads
  • geostatic - Geostatic stress states
  • indirectcontrol - Indirect displacement control
  • indirectcontractioncontrol - Indirect displacement – contraction ring control
  • initializematerial - Initialize materials
  • modelupdate - Update the model
  • nodeforces - Concentrated node forces
  • setfield - Set a field to a prescribed value
  • setinitialconditions - Set initial conditions to elements
  • changematerialproperty - Change a material property during a step
  • Implementing your own step actions
  • Implementing your own loads
• Utilities
  • Matrix conversion from COO sparse format to CSR format
  • Gathering efficiently of element results
  • Time stepping
  • Parent element faces and facet quadrature
• Variables
  • FieldVariable
  • ScalarVariable