Developer documentation

Contents

• Overview
  • Architecture of the project
    • Speed
    • Portability
  • Folder architecture
• CMake
  • Architecture of the build system
  • CMake Compilation
  • Notes for maintaining the build system
• Cython
  • Overview
  • Interfacing with cpp
  • Numpy and eigency
  • Compilation
• Elements
  • Overview
  • Descriptions of the elements
• Kokkos
• Testing Infrastructure
  • Coverage
  • Disabling Tests

Muscat Package Tree

• Muscat Cpp API
  • Containers
    • Geo supports
    • Element Names
    • Mesh
      • Mesh
      • ElementsContainer
      • AllElements
    • Tags
      • Tag
      • Tags
    • Filters
      • ElementFilterBase
      • ElementFilterEvaluated
      • ElementFilter
      • ElementFilterIntersection
    • Unstructured Mesh Tools
      • GetElementsCenters()
      • GetElementsCenters()
  • Finite Element Tools
    • DofNumbering
      • DofNumbering
    • Integration Rules
      • IntegrationRule
      • SpaceIntegrationRule
      • IntegrationRulesAlmanac
    • Finite Element Spaces
    • Integration
      • LocalSpace
      • MonoElementsIntegralCpp
    • Weak form classes
      • WeakTerm
      • WeakMonom
      • WeakForm
    • Spaces
      • ElementSpace
      • Space
      • SpaceAtIP
      • EvaluateSpaceAt()
      • EvaluateSpaceAt()
  • Helper Functions
    • ToString()
  • Implicit Geometry Engine
    • ImplicitGeometryBase
      • ImplicitGeometryBase::ImplicitGeometryBase()
      • ImplicitGeometryBase::GetDistanceToPoints()
      • ImplicitGeometryBase::GetDistanceToMesh()
      • ImplicitGeometryBase::SetInsideOutOn()
      • ImplicitGeometryBase::SetInsideOutOff()
      • ImplicitGeometryBase::SetInsideOut()
      • ImplicitGeometryBase::GetInsideOut()
  • Linear Algebra Tools
    • inv22()
    • inv33()
    • GetInv_Jacobian_Det()
    • GetNormal()
    • EigenSolvers
      • EigenSolvers::EigenSpCG
      • EigenSolvers::EigenSpLU
      • EigenSolvers::EigenSpQR
      • EigenSolvers::EigenSpBiCGSTAB
      • EigenSolvers::EigenSolvers()
      • EigenSolvers::Clean()
      • EigenSolvers::ForceNumberOfThreads()
      • EigenSolvers::SetSolverType()
      • EigenSolvers::SetOp()
      • EigenSolvers::Solve()
      • EigenSolvers::GetSPQRRank()
      • EigenSolvers::GetSPQR_R_nonZeros()
      • EigenSolvers::GetSPQR_R()
      • EigenSolvers::GetSPQR_P()
      • EigenSolvers::GetSPQR_Q_nonZeros()
      • EigenSolvers::GetSPQR_Q()
      • EigenSolvers::cgSolver
      • EigenSolvers::luSolver
      • EigenSolvers::spqrSolver
      • EigenSolvers::bicgstabSolver
      • EigenSolvers::A
      • EigenSolvers::A_rowmajor
      • EigenSolvers::solverType
      • EigenSolvers::Q
      • EigenSolvers::R
    • Numpy like operators
      • NonZero()
      • Intersect1D()
      • Union1D()

Muscat Package Tree

• Muscat package
  • Subpackages
    • Muscat.Actions package
    • Muscat.Bridges package
    • Muscat.Containers package
    • Muscat.Experimental package
    • Muscat.FE package
    • Muscat.GeometricalTools package
    • Muscat.Helpers package
    • Muscat.IO package
    • Muscat.ImplicitGeometry package
    • Muscat.LinAlg package
    • Muscat.MeshTools package
    • Muscat.TestData package
  • Submodules
    • Muscat.Info module
    • Muscat.Simple module
    • Muscat.Types module