Muscat Cpp API

This chapter presents the C++ API available in the library. This is a work in progress and the API can change at any time.

• Containers
  • Geo supports
    • GeoNA
    • GeoPoint
    • GeoBar
    • GeoTri
    • GeoQuad
    • GeoTet
    • GeoPyr
    • GeoWed
    • GeoHex
  • Element Names
    • Point_1
    • Bar_2
    • Bar_3
    • Triangle_6
    • Quadrangle_8
    • Quadrangle_9
    • Tetrahedron_4
    • Pyramid_5
    • Wedge_6
    • Hexahedron_8
    • Tetrahedron_10
    • Pyramid_13
    • Wedge_15
    • Wedge_18
    • Hexahedron_20
    • Hexahedron_27
    • elementsInfo
  • Mesh
    • Muscat::Mesh
      • Mesh()
      • DEFINE_SETGET_SHARED_MAP_MatrixID1()
      • DEFINE_SETGET_SHARED_MAP_MatrixDDD()
      • GetNumberOfNodes()
      • GetElementsDimensionality()
      • AddNodalTag()
      • AddElements()
      • AddElementTag()
      • ComputeGlobalOffsets()
      • ToStr()
      • Print()
      • PrintFull()
      • props
      • nodesTags
      • elements
    • Muscat::ElementsContainer
      • ElementsContainer()
      • GetNumberOfElements()
      • DEFINE_SETGET_SHARED_MAP_MatrixIDD()
      • DEFINE_SETGET_SHARED_MAP_MatrixID1()
      • GetElementType()
      • AddTag()
      • tags
    • Muscat::AllElements
      • StorageType
      • GetElementsOfType()
      • GetElementsOfType()
      • GetNumberOfElements()
      • ToStr()
      • operator[]()
      • operator[]()
      • begin()
      • end()
      • storage
  • Tags
    • Muscat::Tag
      • Tag()
      • DEFINE_SETGET_SHARED_MAP_MatrixID1()
      • SetName()
      • GetName()
      • GetSize()
      • MakeDeepCopy()
      • Tag()
    • Muscat::Tags
      • AddTag()
      • AddTag()
      • Contains()
      • operator[]()
      • ToStr()
      • begin()
      • end()
      • begin()
      • end()
      • MakeDeepCopy()
  • Filters
    • Muscat::ElementFilterBase
      • GetIdsToTreat()
      • GetIdsToTreatComplementary()
    • Muscat::ElementFilterEvaluated
      • GetIdsToTreat()
      • SetIdsToTreatFor()
      • Clear()
      • ToStr()
      • begin()
      • end()
    • Muscat::ElementFilter
      • ZONE
      • ElementFilter()
      • AddTag()
      • SetDimensionality()
      • CheckTags()
      • GetIdsToTreat()
      • ToStr()
      • SetCENTER()
      • SetALLNODES()
      • SetLEASTONENODE()
    • Muscat::ElementFilterIntersection
      • GetIdsToTreat()
  • Unstructured Mesh Tools
    • GetElementsCenters()
    • GetElementsCenters()
• Finite Element Tools
  • DofNumbering
    • Muscat::DofNumbering
      • DofNumbering()
      • GetSize()
      • GetFromConnectivity()
      • SetFromConnectivity()
      • GetDiscontinuous()
      • SetDiscontinuous()
      • ComputeNumberingFromConnectivity()
      • ComputeNumberingNoSharedDof()
      • ComputeNumberingGeneral()
      • HasNumberingFor()
      • InitNumberingFor()
      • GetNumberingFor()
      • GetNumberingFor()
      • SetNumbering()
      • begin()
      • end()
      • GetDofOfkey()
      • GetDofOfPoint()
      • GetSizeOfDofToPoint()
      • GetdoftopointLeft()
      • GetdoftopointRight()
      • computeDofToPoint()
      • computeDofToCell()
      • GetSizeOfDofToCell()
      • GetdoftocellLeft()
      • GetdoftocellRight()
      • GetKeyFor()
      • ToStr()
  • Integration Rules
    • Muscat::ElementaryQuadrature
      • GetNumberOfPoints()
      • SetPointsWeights()
      • p
      • weights
      • elementType
    • Muscat::MeshQuadrature
      • GetIR()
      • storage
    • IntegrationRulesAlmanac
    • GetPythonDefinedIntegrationRules()
  • Finite Element Spaces
    • GetFESpaceFor()
    • GetAvailableSpaces()
  • Integration
    • Muscat::LocalSpace
      • DEFINE_SETGET_VECTOR_SHARED_MAP_MatrixDD1()
      • DEFINE_SETGET_VECTOR_SHARED_MAP_MatrixDDD()
      • Init()
      • resize()
      • LocalSpace()
      • GetNxNyNz()
      • GetBxByBz()
      • SetActiveIntegrationPoint()
      • dimensionality
      • numberOfShapeFunctions
      • numberOfIntegrationPoints
      • activeIntegrationPoint
      • valN
      • valdphidxi
      • BxByBz
    • Muscat::MonoElementsIntegralCpp
      • DEFINE_SETGET_SHARED_MAP_MatrixDDD()
      • DEFINE_SETGET_SHARED_MAP_MatrixIDD()
      • DEFINE_SETGET_VECTOR_SHARED_MAP_MatrixIDD()
      • DEFINE_SETGET_VECTOR_SHARED_MAP_MatrixDD1()
      • DEFINE_SETGET_VECTOR_SHARED_MAP_MatrixDDD()
      • SetLocalOffsets()
      • Reset()
      • SetGeoSpace()
      • SetNumberOfSpaces()
      • InitSpaceS()
      • SetSpaceShapeVal()
      • SetSpaceShapeDerVal()
      • SetNumberOfNumberings()
      • SetNumberOfValues()
      • SetNumberOfIPValues()
      • SetNumberOfUnknownFields()
      • SetUnknownOffset()
      • SetTotalUnknownDofs()
      • SetNumberOfTestFields()
      • SetTotalTestDofs()
      • SetTestOffset()
      • SetNumberOfConstants()
      • SetConstants()
      • SetComputeNormal()
      • SetNumberOfIntegrationPoints()
      • SetIntegrationPointI()
      • ProcessWeakForm()
      • Integrate()
      • IntegrateSpaceDimElementDim()
      • IntegrateSpaceDimElementDimIsSimple()
      • totalUnknownDofs
      • unknownDofsOffset
      • unknownDofsNumbering
      • localUnknownDofsOffset
      • maxsizelocalUnknownDofs
      • totalTestDofs
      • testDofsOffset
      • testDofsNumbering
      • localTestDofsOffset
      • maxsizelocalTestDofs
      • constants
      • iw
      • ip
      • totalvijcpt
      • vK
      • iK
      • jK
      • F
      • hasnormal
      • onlyEvaluation
      • onlyUpper
      • nodes
      • connectivity
      • geoSpaceNumber
      • lspaces
      • lnumbering
      • values
      • ipvalues
  • Weak form classes
    • Muscat::WeakTerm
      • WeakTerm()
      • fieldName
      • derCoordName
      • derDegree
      • constant
      • normal
      • spaceIndex_
      • derCoordIndex_
      • numberingIndex_
      • valuesIndex_
      • modeIndex_
      • internalType
      • operator<<
    • Muscat::WeakMonom
      • WeakMonom()
      • prefactor
      • prod
      • operator<<
    • Muscat::WeakForm
      • GetNumberOfTerms()
      • form
      • operator<<
  • Spaces
    • Muscat::ElementSpace
      • GetDimensionality()
      • GetNumberOfShapeFunctions()
      • GetDofAttachment()
      • AppendDofAttachment()
      • GetValOfShapeFunctionsAt()
      • GetValOfShapeFunctionsAt()
      • GetValOfShapeFunctionsDerAt()
      • GetValOfShapeFunctionsDerAt()
      • GetValOfShapeFunctionsDerDerAt()
      • GetValOfShapeFunctionsDerDerAt()
      • elementType
      • geoSupport
      • storage
      • posN
      • dimensionality
      • SFV
      • SFDV
      • SFDDV
    • Muscat::Space
      • GetNumberOfShapeFunctionsFor()
      • AddDofTo()
      • GetSpaceFor()
      • Print()
      • ToStr()
      • name
      • type
      • storage
    • Muscat::SpaceAtIP
      • SetNumerOfValuesFor()
      • SetValuesFor()
      • name
      • type
      • storage
    • EvaluateSpaceAt()
    • EvaluateSpaceAt()
• Helper Functions
  • ToString()
• Implicit Geometry Engine
  • Muscat::ImplicitGeometryBase
    • ImplicitGeometryBase()
    • GetDistanceToPoints()
    • GetDistanceToMesh()
    • SetInsideOutOn()
    • SetInsideOutOff()
    • SetInsideOut()
    • GetInsideOut()
• Linear Algebra Tools
  • inv22()
  • inv33()
  • GetInv_Jacobian_Det()
  • GetNormal()
  • Muscat::EigenSolvers
    • EigenSpCG
    • EigenSpLU
    • EigenSpQR
    • EigenSpBiCGSTAB
    • EigenSolvers()
    • Clean()
    • ForceNumberOfThreads()
    • SetSolverType()
    • SetOp()
    • Solve()
    • GetSPQRRank()
    • GetSPQR_R_nonZeros()
    • GetSPQR_R()
    • GetSPQR_P()
    • GetSPQR_Q_nonZeros()
    • GetSPQR_Q()
    • cgSolver
    • luSolver
    • spqrSolver
    • bicgstabSolver
    • A
    • A_rowmajor
    • solverType
    • Q
    • R
  • Numpy like operators
    • NonZero()
    • Intersect1D()
    • Union1D()