Documentation for alamo

Getting Started

Initial step-by-step instructions for downloading, building, and running Alamo. Basic instructions on troubleshooting.

Start here if you’re brand new

Running Tests

Explore the set of examples and regression tests that demonstrate Alamo functionality.

Next steps after compiling Alamo

SimBA

Use the Alamo Simulation Browser Analysis system to manage Alamo simulations for regression tests or your own projects.

Optional but useful for regular users

API and Inputs

Browse the auto-generated documentation for Alamo classes and input file input specifications.

For those using existing code to run new siulations.

Developer Instructions

Basics of Alamo design philosophy and practice. How to create branches, implement new models, run tests, and avoid breaking the repository.

Starting point for all new alamo developers

Alamo’s autodoc system

Alamo’s custom auto-documentation and test system designed to enforce documentation and testing standards, while preventing stagnant/depricated content.

Required reading for all developers

Table of contents

Contents:

• Getting Started
  • Downloading Alamo
  • Installing dependencies
  • Configuring
  • Compiling
  • Testing
  • Common Error Messages
  • Generating this documentation
  • Compiling on STAMPEDE2
• SimBA
  • Running SimBA
  • Updating SimBA Records
  • Sharing results on the network
• Autodoc and Autotest
  • Autodoc system
    • Parser comments
    • Header comments
    • ReStructuredText
    • Documentation generation
  • Autotest system
    • Test requirements
    • Creating a test
    • Input file directives
    • Test verification
• Tests
• Inputs
  • BC
    • BC::Constant
    • BC::Step
    • BC::Operator
      • BC::Operator::Elastic
  • IC
    • IC::Affine
    • IC::BMP
    • IC::Constant
    • IC::Cuboid
    • IC::DoubleNotch
    • IC::Ellipse
    • IC::Ellipsoid
    • IC::Expression
    • IC::Laminate
    • IC::Notch
    • IC::PerturbedInterface
    • IC::PS
    • IC::PSRead
    • IC::Sphere
    • IC::Trig
    • IC::TabulatedInterface
    • IC::Voronoi
  • IO
    • IO::ParmParse
    • IO::WriteMetaData
  • Integrator
    • Integrator::CahnHilliard
    • Integrator::Flame
    • Integrator::Fracture
    • Integrator::HeatConduction
    • Integrator::Mechanics
    • Integrator::PhaseFieldMicrostructure
    • Integrator::PolymerDegradation
    • Integrator::SutureCrack
    • Integrator::ThermoElastic
    • Integrator::TopOp
    • Integrator::Base
      • Integrator::Base::Mechanics
  • Model
    • Model::Interface
      • Model::Interface::Crack
      • Model::Interface::GB
    • Model::Solid
      • Model::Solid::Affine
      • Model::Solid::Elastic
      • Model::Solid::Linear
  • Numeric
    • Numeric::Interpolator
      • Numeric::Interpolator::Linear
      • Numeric::Interpolator::NodeBilinear
  • Operator
    • Operator::Elastic
  • Set
  • Solver
    • Solver::Nonlocal
      • Solver::Nonlocal::Linear
      • Solver::Nonlocal::Newton
  • Util
• Inputs Search
• Developer Guide
  • Step-by-step development guide
  • Tutorial: A new Integrator
  • Conventions
    • Namespaces
      • Regular and Pure Virtual classes
    • Include Guards
    • Member and Argument Variable Names
  • Python (In development)
    • Compiling Alamo Python interface
    • Extending the Alamo Python interface
  • Restart files