libMesh Namespace Reference

Namespaces

 boostcopy
 
 DenseMatrices
 
 FiniteElements
 
 libMeshPrivateData
 
 MacroFunctions
 
 MeshTools
 
 Nemesis
 
 Parallel
 
 Predicates
 
 Quality
 Utility functions for computing element quality indicators.
 
 RBDataDeserialization
 
 RBDataSerialization
 
 ReferenceElem
 Namespace providing access to reference geometric element types.
 
 SparsityPattern
 Defines the sparsity pattern of a sparse matrix.
 
 TensorTools
 
 Threads
 
 Trees
 
 TriangleWrapper
 Namespace that wraps the Triangle mesh generator's API.
 
 Utility
 

Classes

class  AbaqusIO
 
class  AdaptiveTimeSolver
 
class  AdjointDofConstraintValues
 
class  AdjointRefinementEstimator
 
class  AdjointResidualErrorEstimator
 
class  AnalyticFunction
 Wraps a function pointer into a FunctionBase object. More...
 
class  AztecLinearSolver
 
class  BasicOStreamProxy
 
class  BoundaryInfo
 Used by the Mesh to keep track of boundary nodes and elements. More...
 
class  BoundaryMesh
 Specialized mesh used for keeping track of boundary elements. More...
 
class  BoundaryProjectSolution
 
class  BoundaryVolumeSolutionTransfer
 
class  BoundingBox
 
class  BuildProjectionList
 
class  Cell
 The base class for all 3D geometric element types. More...
 
class  CentroidPartitioner
 
class  CheckpointIO
 
struct  CompareElemIdsByLevel
 
struct  CompareTypes
 
struct  CompareTypes< MetaPhysicL::DynamicSparseNumberArray< T, I >, T2 >
 
struct  CompareTypes< std::complex< T >, T >
 
struct  CompareTypes< T, std::complex< T > >
 
struct  CompareTypes< T, T >
 
class  CompositeFEMFunction
 FEMFunction which is a function of another function. More...
 
class  CompositeFunction
 A function that returns a vector whose components are defined by multiple functions. More...
 
class  CondensedEigenSystem
 Extends EigenSystem to allow certain DOFs to be condensed out. More...
 
class  ConstCouplingAccessor
 
class  ConstCouplingRow
 
class  ConstCouplingRowConstIterator
 
class  ConstFEMFunction
 FEMFunction that returns a single value. More...
 
class  ConstFunction
 Function that returns a single value that never changes. More...
 
class  ConstParameterProxy
 
class  ConstTypeTensorColumn
 
class  ContinuationSystem
 
class  ConvergenceFailure
 
class  CouplingAccessor
 
class  CouplingMatrix
 Defines the coupling between variables of a System. More...
 
class  DefaultCoupling
 
class  DenseMatrix
 A matrix object used for finite element assembly and numerics. More...
 
class  DenseMatrixBase
 
class  DenseSubMatrix
 
class  DenseSubVector
 
class  DenseVector
 
class  DenseVectorBase
 
class  DGFEMContext
 Extends FEMContext to work for DG problems. More...
 
class  DiffContext
 
class  DifferentiablePhysics
 
class  DifferentiableQoI
 
class  DifferentiableSystem
 
class  DiffSolver
 
class  DirectSolutionTransfer
 Implements solution transfers for matched variable/mesh case. More...
 
class  DirichletBoundaries
 
class  DirichletBoundary
 Class for specifying Dirichlet boundary conditions as constraints. More...
 
class  DiscontinuityMeasure
 
class  DistributedMesh
 Mesh data structure which is distributed across all processors. More...
 
class  DistributedVector
 
class  DofConstraints
 
class  DofConstraintValueMap
 
class  DofMap
 Manages the degrees of freedom (DOFs) in a simulation. More...
 
class  DofObject
 
class  DSNAOutput
 
class  DSNAOutput< VectorValue< InnerOutput > >
 
class  DTKAdapter
 
class  DTKEvaluator
 
class  DTKSolutionTransfer
 
class  DynamicCastFailure
 
class  Edge
 The base class for all 1D geometric element types. More...
 
class  Edge2
 A 1D geometric element with 2 nodes. More...
 
class  Edge3
 A 1D geometric element with 3 nodes. More...
 
class  Edge4
 A 1D geometric element with 4 nodes. More...
 
class  EigenPreconditioner
 
class  EigenSolver
 Base class which defines the interface for solving eigenproblems. More...
 
class  EigenSparseLinearSolver
 
class  EigenSparseMatrix
 
class  EigenSparseVector
 
class  EigenSystem
 Manages consistently variables, degrees of freedom, and coefficient vectors for eigenvalue problems. More...
 
class  EigenTimeSolver
 
class  Elem
 The base class for all geometric element types. More...
 
class  ElemAssembly
 
class  ElemCutter
 Subdivides a single element using a mesh generator. More...
 
struct  ElemHashUtils
 A struct providing convenience functions for hashing elements. More...
 
class  EnsightIO
 
class  EpetraMatrix
 
class  EpetraVector
 
class  EquationSystems
 Manages multiples systems of equations. More...
 
class  ErrorEstimator
 
class  ErrorVector
 
class  Euler2Solver
 
class  EulerSolver
 
class  ExactErrorEstimator
 
class  ExactSolution
 
class  ExodusII_IO
 Handles reading and writing of Exodus binary files. More...
 
class  ExodusII_IO_Helper
 
class  ExplicitSystem
 Manages consistently variables, degrees of freedom, and coefficient vectors for explicit systems. More...
 
class  Face
 The base class for all 2D geometric element types. More...
 
class  Factory
 Handles name-based creation of objects. More...
 
class  FactoryImp
 
class  FastPoolAllocator
 Boost-derived allocator that can be used with std::containers. More...
 
class  FE
 Template class which generates the different FE families and orders. More...
 
class  FEAbstract
 
class  FEClough
 
class  FEComputeData
 Helper class used with FEInterface::compute_data(). More...
 
class  FEGenericBase
 
class  FEHermite
 
class  FEHierarchic
 
class  FEInterface
 Interface class which provides access to FE functions. More...
 
class  FEL2Hierarchic
 
class  FEL2Lagrange
 
class  FELagrange
 
class  FELagrangeVec
 
class  FEMap
 Computes finite element mapping function values, gradients, etc. More...
 
class  FEMContext
 
class  FEMFunctionBase
 
class  FEMFunctionWrapper
 
class  FEMonomial
 
class  FEMPhysics
 
class  FEMSystem
 
class  FENedelecOne
 
struct  FEOutputType
 
struct  FEOutputType< LAGRANGE_VEC >
 
struct  FEOutputType< NEDELEC_ONE >
 
class  FEScalar
 
class  FESubdivision
 
class  FETransformationBase
 
class  FEType
 Manages the family, order, etc. parameters for a given FE. More...
 
class  FEXYZ
 
class  FEXYZMap
 An implementation of FEMap for "XYZ" elements. More...
 
class  FileError
 
class  FirstOrderUnsteadySolver
 
class  FloatingPointException
 
class  FrequencySystem
 
class  FroIO
 
class  FunctionBase
 Base class for functors that can be evaluated at a point and (optionally) time. More...
 
class  GenericProjector
 
class  GhostingFunctor
 
class  GhostPointNeighbors
 
class  GmshIO
 
class  GMVIO
 
class  GnuPlotIO
 
class  H1FETransformation
 
class  HCurlFETransformation
 
class  Hex
 The base class for all hexahedral element types. More...
 
class  Hex20
 A 3D hexahedral element with 20 nodes. More...
 
class  Hex27
 A 3D hexahedral element with 27 nodes. More...
 
class  Hex8
 A 3D hexahedral element with 8 nodes. More...
 
class  HilbertSFCPartitioner
 Partitioner based on Hilbert's space filling curve algorithm. More...
 
class  HPCoarsenTest
 
class  HPSelector
 
class  HPSingularity
 
class  ImplicitSystem
 Manages consistently variables, degrees of freedom, coefficient vectors, and matrices for implicit systems. More...
 
class  InfCell
 The base class for all 3D infinite geometric element types. More...
 
class  InfEdge2
 A 1D infinite element with 2 nodes. More...
 
class  InfElemBuilder
 
class  InfFE
 Base class for all the infinite geometric element types. More...
 
class  InfHex
 The base class for all 3D infinite hexahedral element types. More...
 
class  InfHex16
 A 3D infinite hexahedral element with 16 nodes. More...
 
class  InfHex18
 A 3D infinite hexahedral element with 18 nodes. More...
 
class  InfHex8
 A 3D infinite hexahedral element with 8 nodes. More...
 
class  InfPrism
 The base class for all 3D infinite prismatic element types. More...
 
class  InfPrism12
 A 3D infinite prismatic element with 12 nodes. More...
 
class  InfPrism6
 A 3D infinite prismatic element with 6 nodes. More...
 
class  InfQuad
 The base class for all 2D infinite quadrilateral element types. More...
 
class  InfQuad4
 A 2D infinite quadrilateral element with 4 nodes. More...
 
class  InfQuad6
 A 2D infinite quadrilateral element with 6 nodes. More...
 
class  IntRange
 
class  InverseDistanceInterpolation
 
class  JumpErrorEstimator
 
class  KellyErrorEstimator
 
class  LaplaceMeshSmoother
 
class  LaplacianErrorEstimator
 
class  LaspackLinearSolver
 
class  LaspackMatrix
 
class  LaspackVector
 
class  LibMeshInit
 
class  LinearImplicitSystem
 Manages consistently variables, degrees of freedom, coefficient vectors, matrices and linear solvers for implicit systems. More...
 
class  LinearPartitioner
 Partitions the elements based solely on their ids. More...
 
class  LinearSolutionMonitor
 
class  LinearSolver
 
class  LocationMap
 std::map-like data structure using hashed Points for keys. More...
 
class  LogicError
 
class  MappedSubdomainPartitioner
 Partitions elements based on user-defined mapping from subdomain ids -> processor ids. More...
 
class  mapvector
 
class  MatlabIO
 
class  MatrixFillAction
 
class  MEDITIO
 
class  MemorySolutionHistory
 Stores past solutions in memory. More...
 
class  Mesh
 Manages a collection of Nodes and Elems. More...
 
struct  mesh_inserter_iterator
 An output iterator for use with packed_range functions. More...
 
class  MeshBase
 Base class for Mesh. More...
 
class  MeshCommunication
 
class  MeshfreeInterpolation
 Base class which defines the mesh-free interpolation interface. More...
 
class  MeshfreeSolutionTransfer
 A SolutionTransfer object that does "mesh free" interpolation. More...
 
class  MeshFunction
 
class  MeshFunctionSolutionTransfer
 SolutionTransfer object which uses a MeshFunction. More...
 
class  MeshInput
 
class  MeshOutput
 
class  MeshRefinement
 Responsible for mesh refinement algorithms and data. More...
 
class  MeshSerializer
 Temporarily serializes a DistributedMesh for output. More...
 
class  MeshSmoother
 
class  METIS_CSR_Graph
 Compressed graph data structure used by MetisPartitioner. More...
 
class  MetisPartitioner
 Partitioner which interfaces with the METIS library. More...
 
class  MortonSFCPartitioner
 Partitioner based on Morton's space filling curve algorithm. More...
 
struct  myhash
 
class  NameBasedIO
 
class  Nemesis_IO
 
class  Nemesis_IO_Helper
 
class  NewmarkSolver
 
class  NewmarkSystem
 Implements the Newmark time integration scheme. More...
 
class  NewtonSolver
 
class  NloptOptimizationSolver
 
class  Node
 A geometric point in (x,y,z) space associated with a DOF. More...
 
class  NodeConstraints
 
class  NodeElem
 A zero-dimensional geometric entity implementing the Elem interface. More...
 
class  NonlinearImplicitSystem
 Manages consistently variables, degrees of freedom, coefficient vectors, matrices and non-linear solvers for implicit systems. More...
 
class  NonlinearSolver
 
class  NoSolutionHistory
 For storing and retrieving timestep data. More...
 
class  NotImplemented
 
class  NoxNonlinearSolver
 
struct  null_output_iterator
 A do-nothing output iterator implementation. More...
 
class  NumericVector
 Provides a uniform interface to vector storage schemes for different linear algebra libraries. More...
 
class  OFFIO
 Reads OOF OOGL triangulated surface files. More...
 
class  OldSolutionBase
 
class  OldSolutionCoefs
 
class  OldSolutionValue
 
class  OptimizationSolver
 
class  OptimizationSystem
 
class  OrderWrapper
 
class  ParallelMesh
 
class  ParallelObject
 An object whose state is distributed along a set of processors. More...
 
class  ParameterAccessor
 Base class for reading/writing sensitivity parameters. More...
 
class  ParameterMultiAccessor
 Stores a user-provided pointer to a parameter. More...
 
class  ParameterMultiPointer
 Stores multiple user-provided pointers. More...
 
class  ParameterPointer
 Stores/modifies a user-provided pointer to a parameter. More...
 
class  ParameterProxy
 
class  Parameters
 
class  ParameterVector
 Specifies parameters for parameter sensitivity calculations. More...
 
class  ParmetisHelper
 Pointer-to-implementation class used by ParmetisPartitioner. More...
 
class  ParmetisPartitioner
 Partitioner which provides an interface to ParMETIS. More...
 
class  ParsedFEMFunction
 Support for using parsed functions in FEMSystem. More...
 
class  ParsedFEMFunctionParameter
 Stores a pointer to a ParsedFEMFunction and a string for the parameter. More...
 
class  ParsedFunction
 A Function defined by a std::string. More...
 
class  ParsedFunctionParameter
 Stores a pointer to a parsed function and a string for the parameter. More...
 
class  Partitioner
 Base class for all concrete Partitioner instantiations. More...
 
class  Patch
 
class  PatchRecoveryErrorEstimator
 
class  PerfData
 Data object managed by PerfLog. More...
 
struct  PerfItem
 
class  PerfLog
 Responsible for timing and summarizing events. More...
 
class  PerfMon
 A class for interfacing with hardware timers. More...
 
class  PeriodicBoundaries
 Maps between boundary ids and PeriodicBoundaryBase objects. More...
 
class  PeriodicBoundary
 Used for implementing periodic BCs via constraints. More...
 
class  PeriodicBoundaryBase
 Base class for all PeriodicBoundary implementations. More...
 
class  PetscDiffSolver
 
class  PetscDMWrapper
 
class  PetscLinearSolver
 
class  PetscMatrix
 SparseMatrix interface to PETSc Mat. More...
 
class  PetscNonlinearSolver
 
class  PetscPreconditioner
 
class  PetscSolverException
 
class  PetscVector
 NumericVector interface to PETSc Vec. More...
 
class  Plane
 A geometric object representing a planar surface. More...
 
class  PltLoader
 
class  Point
 A geometric point in (x,y,z) space. More...
 
class  PointerToPointerIter
 
class  PointLocatorBase
 
class  PointLocatorTree
 
class  PointNeighborCoupling
 
class  PoolAllocator
 Boost-derived allocator that can be used with std::containers. More...
 
class  PostscriptIO
 
class  Preconditioner
 
class  Prism
 The base class for all prismatic element types. More...
 
class  Prism15
 A 3D prismatic element with 15 nodes. More...
 
class  Prism18
 A 3D prismatic element with 18 nodes. More...
 
class  Prism6
 A 3D prismatic element with 6 nodes. More...
 
class  Problem_Interface
 
class  Pyramid
 The base class for all pyramid element types. More...
 
class  Pyramid13
 A 3D pyramid element with 13 nodes. More...
 
class  Pyramid14
 A 3D pyramid element with 14 nodes. More...
 
class  Pyramid5
 A 3D pyramid element with 5 nodes. More...
 
class  QBase
 Base class for all quadrature families and orders. More...
 
class  QClough
 Implements quadrature rules for Clough-Tocher macroelements. More...
 
class  QComposite
 A quadrature rule for subdivided elements. More...
 
class  QConical
 Conical product quadrature rules for Tri and Tet elements. More...
 
class  QGauss
 Implements 1, 2, and 3D "Gaussian" quadrature rules. More...
 
class  QGaussLobatto
 Implements 1D and 2/3D tensor product Gauss-Lobatto quadrature rules. More...
 
class  QGrid
 Implements grid-based quadrature rules suitable for non-smooth functions. More...
 
class  QGrundmann_Moller
 Implements the quadrature rules of Grundmann and Moller in 2D and 3D. More...
 
class  QJacobi
 Implements 1D Gauss-Jacobi quadrature rules of various orders. More...
 
class  QMonomial
 Implements quadrature rules for non-tensor polynomials. More...
 
class  QoISet
 Used to specify quantities of interest in a simulation. More...
 
class  QSimpson
 Implements Simpson's rule, i.e. nodal quadrature for quadratic elements. More...
 
class  QTrap
 Implements trapezoidal rule, i.e. nodal quadrature for linear elements. More...
 
class  Quad
 The base class for all quadrilateral element types. More...
 
class  Quad4
 A 2D quadrilateral element with 4 nodes. More...
 
class  Quad8
 A 2D quadrilateral element with 8 nodes. More...
 
class  Quad9
 A 2D quadrilateral element with 9 nodes. More...
 
class  QuadShell4
 A 2D quadrilateral shell element with 4 nodes. More...
 
class  QuadShell8
 A 2D quadrilateral shell element with 8 nodes. More...
 
class  RadialBasisInterpolation
 Does radial basis function interpolation using Nanoflann. More...
 
class  RawAccessor
 
class  RawAccessor< TypeNTensor< N, ScalarType > >
 
struct  RawFieldType
 
struct  RawFieldType< Gradient >
 
struct  RawFieldType< Number >
 
struct  RawFieldType< Real >
 
struct  RawFieldType< RealGradient >
 
struct  RawFieldType< RealTensor >
 
struct  RawFieldType< Tensor >
 
struct  RawFieldType< TypeNTensor< 3, Number > >
 
struct  RawFieldType< TypeNTensor< 3, Real > >
 
class  RBAssemblyExpansion
 
class  RBConstruction
 
class  RBConstructionBase
 
class  RBEIMAssembly
 
class  RBEIMConstruction
 
class  RBEIMEvaluation
 
class  RBEIMTheta
 
class  RBEvaluation
 
class  RBParameters
 
class  RBParametrized
 
class  RBParametrizedFunction
 Provides a reduced basis parameterized function. More...
 
class  RBSCMConstruction
 
class  RBSCMEvaluation
 
class  RBTemporalDiscretization
 Encapsulates the details of the generalized Euler discretization. More...
 
class  RBTheta
 
class  RBThetaExpansion
 
class  ReferenceCountedObject
 
class  ReferenceCounter
 Common base for all objects whose creations/destructions are counted. More...
 
class  RefinementSelector
 
class  RemoteElem
 Used by ParallelMesh to represent an Elem owned by another processor. More...
 
class  ReplicatedMesh
 Mesh data structure replicated on all processors. More...
 
class  ResidualContext
 
struct  ScalarTraits
 
struct  ScalarTraits< MetaPhysicL::DynamicSparseNumberArray< T, I > >
 
struct  ScalarTraits< std::complex< T > >
 
class  SecondOrderUnsteadySolver
 
class  SensitivityData
 Holds completed parameter sensitivity calculations. More...
 
class  SerialMesh
 
class  SFCPartitioner
 Partitioner based on different types of space filling curves. More...
 
class  ShellMatrix
 
class  SiblingCoupling
 
class  Side
 Proxy class for efficiently representing an Elem's side. More...
 
class  SideEdge
 
class  SimpleRange
 
class  Singleton
 Base class for all library singleton objects. More...
 
class  SlepcEigenSolver
 EigenSolver implementation based on SLEPc. More...
 
class  SolutionHistory
 For storing and retrieving timestep data. More...
 
class  SolutionTransfer
 Base class for all SolutionTransfer implementations. More...
 
class  SolverConfiguration
 
class  SolverException
 
class  SparseMatrix
 
class  SparseShellMatrix
 
class  Sphere
 A geometric object representing a sphere. More...
 
class  StatisticsVector
 A std::vector derived class for implementing simple statistical algorithms. More...
 
class  SteadySolver
 
class  StoredRange
 Utility class for defining generic ranges for threading. More...
 
class  SubdomainPartitioner
 Independently partitions chunks of subdomains and combines the results. More...
 
class  SumShellMatrix
 
class  Surface
 Base class for Plane and Sphere classes. More...
 
struct  SyncLocalIDs
 
struct  SyncNodalPositions
 
struct  SyncRefinementFlags
 
class  System
 Manages consistently variables, degrees of freedom, and coefficient vectors. More...
 
class  SystemNorm
 
class  SystemSubset
 
class  SystemSubsetBySubdomain
 
class  TaoOptimizationSolver
 
class  TecplotIO
 
class  TensorShellMatrix
 
class  TensorValue
 
class  TestClass
 
class  Tet
 The base class for all tetrahedral element types. More...
 
class  Tet10
 A 3D tetrahedral element with 10 nodes. More...
 
class  Tet4
 A 3D tetrahedral element with 4 nodes. More...
 
class  TetGenIO
 
class  TetGenMeshInterface
 
class  TetGenWrapper
 
class  TimeSolver
 
class  TopologyMap
 Enables topology-based lookups of nodes. More...
 
class  TransientRBAssemblyExpansion
 
class  TransientRBConstruction
 
class  TransientRBEvaluation
 
class  TransientRBThetaExpansion
 
class  TransientSystem
 Manages storage and variables for transient systems. More...
 
class  Tree
 Tree class templated on the number of leaves on each node. More...
 
class  TreeBase
 
class  TreeNode
 Base class for different Tree types. More...
 
class  Tri
 The base class for all triangular element types. More...
 
class  Tri3
 A 2D triangular element with 3 nodes. More...
 
class  Tri3Subdivision
 A surface shell element used in mechanics calculations. More...
 
class  Tri6
 A 2D triangular element with 6 nodes. More...
 
class  TriangleInterface
 
class  TrilinosPreconditioner
 
class  TriShell3
 
struct  tuple_n
 
struct  tuple_n< 0, T >
 
class  TwostepTimeSolver
 
class  TypeNTensor
 
struct  TypesEqual
 
struct  TypesEqual< T, T >
 
class  TypeTensor
 
class  TypeTensorColumn
 
class  TypeVector
 
class  UCDIO
 
class  UniformRefinementEstimator
 
class  UnsteadySolver
 
class  UnstructuredMesh
 Base class for Replicated and Distributed meshes. More...
 
class  UNVIO
 
class  Variable
 A variable which is solved for in a System of equations. More...
 
class  VariableGroup
 
class  VariationalMeshSmoother
 
class  vectormap
 
class  VectorSetAction
 
class  VectorValue
 
class  VTKIO
 
class  WeightedPatchRecoveryErrorEstimator
 
class  WendlandRBF
 Interface for evaluating Wendland's radial basis functions. More...
 
class  WrappedFunction
 Wrap a libMesh-style function pointer into a FunctionBase object. More...
 
class  WrappedFunctor
 
class  Xdr
 C++ interface for the XDR (eXternal Data Representation) format. More...
 
class  XdrIO
 
class  ZeroFunction
 ConstFunction that simply returns 0. More...
 

Typedefs

typedef DynamicSparseNumberArray< Real, dof_id_typeDSNAN
 
template<typename T >
using UniquePtr = std::unique_ptr< T >
 
typedef std::map< dof_id_type, Real, std::less< dof_id_type >, Threads::scalable_allocator< std::pair< const dof_id_type, Real > > > DofConstraintRow
 
typedef std::map< const Node *, Real, std::less< const Node * >, Threads::scalable_allocator< std::pair< const Node *const, Real > > > NodeConstraintRow
 
typedef int32_t eigen_idx_type
 
typedef Eigen::SparseMatrix< Number, Eigen::RowMajor, eigen_idx_typeEigenSM
 
typedef Eigen::Matrix< Number, Eigen::Dynamic, 1 > EigenSV
 
typedef std::unordered_multiset< Elem *, ElemHashUtils, ElemHashUtilsunordered_multiset_elem
 
typedef StoredRange< MeshBase::element_iterator, Elem * > ElemRange
 
typedef StoredRange< MeshBase::const_element_iterator, const Elem * > ConstElemRange
 
typedef FEGenericBase< RealFEBase
 
typedef TensorValue< NumberNumberTensorValue
 
typedef NumberTensorValue Tensor
 
typedef VectorValue< NumberNumberVectorValue
 
typedef NumberVectorValue Gradient
 
typedef FEGenericBase< RealGradientFEVectorBase
 
typedef VectorValue< RealRealVectorValue
 
typedef TensorValue< RealRealTensorValue
 
typedef RealVectorValue RealGradient
 
typedef RealTensorValue RealTensor
 
typedef TestClass subdomain_id_type
 
typedef int8_t boundary_id_type
 
typedef uint8_t dof_id_type
 
typedef uint8_t unique_id_type
 
typedef dof_id_type numeric_index_type
 
typedef uint8_t processor_id_type
 
typedef uint64_t largest_id_type
 
typedef std::complex< RealComplex
 
typedef std::complex< RealCOMPLEX
 
typedef Real Number
 
typedef DistributedMesh DefaultMesh
 
typedef Real REAL
 
typedef StoredRange< MeshBase::node_iterator, Node * > NodeRange
 
typedef StoredRange< MeshBase::const_node_iterator, const Node * > ConstNodeRange
 
typedef BasicOStreamProxy OStreamProxy
 
typedef LinearImplicitSystem SteadyLinearSystem
 
typedef TransientSystem< LinearImplicitSystemTransientImplicitSystem
 
typedef TransientSystem< LinearImplicitSystemTransientLinearImplicitSystem
 
typedef TransientSystem< NonlinearImplicitSystemTransientNonlinearImplicitSystem
 
typedef TransientSystem< ExplicitSystemTransientExplicitSystem
 
typedef TransientSystem< SystemTransientBaseSystem
 
typedef TransientSystem< EigenSystemTransientEigenSystem
 
template<size_t I, typename T >
using tuple_of = typename tuple_n< I, T >::template type<>
 

Enumerations

enum  VariableIndexing { SYSTEM_VARIABLE_ORDER = 0, LOCAL_VARIABLE_ORDER }
 
enum  LinearConvergenceReason : int {
  CONVERGED_RTOL_NORMAL = 1, CONVERGED_ATOL_NORMAL = 9, CONVERGED_RTOL = 2, CONVERGED_ATOL = 3,
  CONVERGED_ITS = 4, CONVERGED_CG_NEG_CURVE = 5, CONVERGED_CG_CONSTRAINED = 6, CONVERGED_STEP_LENGTH = 7,
  CONVERGED_HAPPY_BREAKDOWN = 8, DIVERGED_NULL = -2, DIVERGED_ITS = -3, DIVERGED_DTOL = -4,
  DIVERGED_BREAKDOWN = -5, DIVERGED_BREAKDOWN_BICG = -6, DIVERGED_NONSYMMETRIC = -7, DIVERGED_INDEFINITE_PC = -8,
  DIVERGED_NAN = -9, DIVERGED_INDEFINITE_MAT = -10, DIVERGED_PCSETUP_FAILED = -11, CONVERGED_ITERATING = 0,
  UNKNOWN_FLAG = -128
}
 
enum  EigenSolverType : int {
  POWER =0, LAPACK, SUBSPACE, ARNOLDI,
  LANCZOS, KRYLOVSCHUR, INVALID_EIGENSOLVER
}
 
enum  EigenProblemType : int {
  NHEP =0, HEP, GNHEP, GHEP,
  GHIEP, INVALID_EIGENPROBLEMTYPE
}
 
enum  PositionOfSpectrum : int {
  LARGEST_MAGNITUDE =0, SMALLEST_MAGNITUDE, TARGET_MAGNITUDE, LARGEST_REAL,
  SMALLEST_REAL, TARGET_REAL, LARGEST_IMAGINARY, SMALLEST_IMAGINARY,
  TARGET_IMAGINARY, INVALID_Postion_of_Spectrum, INVALID_POSITION_OF_SPECTRUM
}
 
enum  ElemQuality : int {
  ASPECT_RATIO =0, SKEW, SHEAR, SHAPE,
  MAX_ANGLE, MIN_ANGLE, CONDITION, DISTORTION,
  TAPER, WARP, STRETCH, DIAGONAL,
  ASPECT_RATIO_BETA, ASPECT_RATIO_GAMMA, SIZE, JACOBIAN
}
 
enum  ElemType : int {
  EDGE2 = 0, EDGE3 = 1, EDGE4 = 2, TRI3 = 3,
  TRI6 = 4, QUAD4 = 5, QUAD8 = 6, QUAD9 = 7,
  TET4 = 8, TET10 = 9, HEX8 = 10, HEX20 = 11,
  HEX27 = 12, PRISM6 = 13, PRISM15 = 14, PRISM18 = 15,
  PYRAMID5 = 16, PYRAMID13 = 17, PYRAMID14 = 18, INFEDGE2 = 19,
  INFQUAD4 = 20, INFQUAD6 = 21, INFHEX8 = 22, INFHEX16 = 23,
  INFHEX18 = 24, INFPRISM6 = 25, INFPRISM12 = 26, NODEELEM = 27,
  REMOTEELEM = 28, TRI3SUBDIVISION = 29, TRISHELL3 = 30, QUADSHELL4 = 31,
  QUADSHELL8 = 32, INVALID_ELEM
}
 
enum  ErrorEstimatorType : int {
  INVALID = -1, ADJOINT_REFINEMENT = 0, ADJOINT_RESIDUAL = 1, DISCONTINUITY_MEASURE = 2,
  EXACT = 3, KELLY = 4, LAPLACIAN = 5, PATCH_RECOVERY = 6,
  WEIGHTED_PATCH_RECOVERY = 7, UNIFORM_REFINEMENT = 8
}
 
enum  FEFamily : int {
  LAGRANGE = 0, HIERARCHIC = 1, MONOMIAL = 2, L2_HIERARCHIC = 6,
  L2_LAGRANGE = 7, BERNSTEIN = 3, SZABAB = 4, XYZ = 5,
  INFINITE_MAP = 11, JACOBI_20_00 = 12, JACOBI_30_00 = 13, LEGENDRE = 14,
  CLOUGH = 21, HERMITE = 22, SUBDIVISION = 23, SCALAR = 31,
  LAGRANGE_VEC = 41, NEDELEC_ONE = 42, INVALID_FE = 99
}
 
enum  FEContinuity : int { DISCONTINUOUS, C_ZERO, C_ONE, H_CURL }
 
enum  FEFieldType : int { TYPE_SCALAR = 0, TYPE_VECTOR }
 
enum  InfMapType : int { CARTESIAN =0, SPHERICAL, ELLIPSOIDAL, INVALID_INF_MAP }
 
enum  IOPackage : int {
  TECPLOT, GMV, GMSH, VTK,
  DIVA, TETGEN, UCD, LIBMESH,
  INVALID_IO_PACKAGE
}
 
enum  FEMNormType : int {
  L2 = 0, H1 = 1, H2 = 2, HCURL = 3,
  HDIV = 4, L1 = 5, L_INF = 6, H1_SEMINORM = 10,
  H2_SEMINORM = 11, HCURL_SEMINORM = 12, HDIV_SEMINORM = 13, W1_INF_SEMINORM = 15,
  W2_INF_SEMINORM = 16, DISCRETE_L1 = 20, DISCRETE_L2 = 21, DISCRETE_L_INF = 22,
  H1_X_SEMINORM = 31, H1_Y_SEMINORM = 32, H1_Z_SEMINORM = 33, INVALID_NORM = 42
}
 
enum  Order : int {
  CONSTANT = 0, FIRST = 1, SECOND = 2, THIRD = 3,
  FOURTH = 4, FIFTH = 5, SIXTH = 6, SEVENTH = 7,
  EIGHTH = 8, NINTH = 9, TENTH = 10, ELEVENTH = 11,
  TWELFTH = 12, THIRTEENTH = 13, FOURTEENTH = 14, FIFTEENTH = 15,
  SIXTEENTH = 16, SEVENTEENTH = 17, EIGHTTEENTH = 18, NINETEENTH = 19,
  TWENTIETH = 20, TWENTYFIRST = 21, TWENTYSECOND = 22, TWENTYTHIRD = 23,
  TWENTYFOURTH = 24, TWENTYFIFTH = 25, TWENTYSIXTH = 26, TWENTYSEVENTH = 27,
  TWENTYEIGHTH = 28, TWENTYNINTH = 29, THIRTIETH = 30, THIRTYFIRST = 31,
  THIRTYSECOND = 32, THIRTYTHIRD = 33, THIRTYFOURTH = 34, THIRTYFIFTH = 35,
  THIRTYSIXTH = 36, THIRTYSEVENTH = 37, THIRTYEIGHTH = 38, THIRTYNINTH = 39,
  FORTIETH = 40, FORTYFIRST = 41, FORTYSECOND = 42, FORTYTHIRD = 43,
  INVALID_ORDER
}
 
enum  ParallelType : int {
  AUTOMATIC =0, SERIAL, PARALLEL, GHOSTED,
  INVALID_PARALLELIZATION
}
 
enum  PointLocatorType : int { TREE = 0, TREE_ELEMENTS, TREE_LOCAL_ELEMENTS, INVALID_LOCATOR }
 
enum  PreconditionerType : int {
  IDENTITY_PRECOND =0, JACOBI_PRECOND, BLOCK_JACOBI_PRECOND, SOR_PRECOND,
  SSOR_PRECOND, EISENSTAT_PRECOND, ASM_PRECOND, CHOLESKY_PRECOND,
  ICC_PRECOND, ILU_PRECOND, LU_PRECOND, USER_PRECOND,
  SHELL_PRECOND, AMG_PRECOND, INVALID_PRECONDITIONER
}
 
enum  QuadratureType : int {
  QGAUSS = 0, QJACOBI_1_0 = 1, QJACOBI_2_0 = 2, QSIMPSON = 3,
  QTRAP = 4, QGRID = 5, QGRUNDMANN_MOLLER = 6, QMONOMIAL = 7,
  QCONICAL = 8, QGAUSS_LOBATTO = 9, QCLOUGH = 21, QCOMPOSITE = 31,
  INVALID_Q_RULE = 127
}
 
enum  SolverPackage : int { PETSC_SOLVERS =0, SLEPC_SOLVERS, NLOPT_SOLVERS }
 
enum  SolverType : int {
  CG =0, CGN, CGS, CR,
  QMR, TCQMR, TFQMR, BICG,
  BICGSTAB, MINRES, GMRES, LSQR,
  JACOBI, SOR_FORWARD, SOR_BACKWARD, SSOR,
  RICHARDSON, CHEBYSHEV, SPARSELU, INVALID_SOLVER
}
 
enum  SubsetSolveMode : int { SUBSET_ZERO = 0, SUBSET_COPY_RHS, SUBSET_DONT_TOUCH }
 
enum  XdrMODE : int {
  UNKNOWN = -1, ENCODE =0, DECODE, WRITE,
  READ
}
 
enum  PetscMatrixType : int { AIJ =0, HYPRE }
 

Functions

bool warned_about_auto_ptr (false)
 
const Number imaginary (0., 1.)
 
bool initialized ()
 
bool closed ()
 
void libmesh_terminate_handler ()
 
void enableFPE (bool on)
 
void enableSEGV (bool on)
 
bool on_command_line (std::string arg)
 
template<typename T >
command_line_value (const std::string &name, T value)
 
template<typename T >
command_line_value (const std::vector< std::string > &name, T value)
 
template<typename T >
command_line_next (std::string name, T value)
 
template<typename T >
void command_line_vector (const std::string &name, std::vector< T > &vec)
 
SolverPackage default_solver_package ()
 
template unsigned short command_line_value< unsigned short > (const std::string &, unsigned short)
 
template unsigned int command_line_value< unsigned int > (const std::string &, unsigned int)
 
template short command_line_value< short > (const std::string &, short)
 
template int command_line_value< int > (const std::string &, int)
 
template float command_line_value< float > (const std::string &, float)
 
template double command_line_value< double > (const std::string &, double)
 
template long double command_line_value< long double > (const std::string &, long double)
 
template std::string command_line_value< std::string > (const std::string &, std::string)
 
template unsigned short command_line_value< unsigned short > (const std::vector< std::string > &, unsigned short)
 
template unsigned int command_line_value< unsigned int > (const std::vector< std::string > &, unsigned int)
 
template short command_line_value< short > (const std::vector< std::string > &, short)
 
template int command_line_value< int > (const std::vector< std::string > &, int)
 
template float command_line_value< float > (const std::vector< std::string > &, float)
 
template double command_line_value< double > (const std::vector< std::string > &, double)
 
template long double command_line_value< long double > (const std::vector< std::string > &, long double)
 
template std::string command_line_value< std::string > (const std::vector< std::string > &, std::string)
 
template unsigned short command_line_next< unsigned short > (std::string, unsigned short)
 
template unsigned int command_line_next< unsigned int > (std::string, unsigned int)
 
template short command_line_next< short > (std::string, short)
 
template int command_line_next< int > (std::string, int)
 
template float command_line_next< float > (std::string, float)
 
template double command_line_next< double > (std::string, double)
 
template long double command_line_next< long double > (std::string, long double)
 
template std::string command_line_next< std::string > (std::string, std::string)
 
template void command_line_vector< unsigned short > (const std::string &, std::vector< unsigned short > &)
 
template void command_line_vector< unsigned int > (const std::string &, std::vector< unsigned int > &)
 
template void command_line_vector< short > (const std::string &, std::vector< short > &)
 
template void command_line_vector< int > (const std::string &, std::vector< int > &)
 
template void command_line_vector< float > (const std::string &, std::vector< float > &)
 
template void command_line_vector< double > (const std::string &, std::vector< double > &)
 
template void command_line_vector< long double > (const std::string &, std::vector< long double > &)
 
void print_trace (std::ostream &out_stream)
 
void write_traceout ()
 
std::string demangle (const char *name)
 
 INSTANTIATE_FE (0)
 
 INSTANTIATE_FE (1)
 
 INSTANTIATE_FE (2)
 
 INSTANTIATE_FE (3)
 
std::ostream & operator<< (std::ostream &os, const FEAbstract &fe)
 
 REINIT_ERROR (0, CLOUGH, reinit)
 
 REINIT_ERROR (0, CLOUGH, edge_reinit)
 
 SIDEMAP_ERROR (0, CLOUGH, side_map)
 
 REINIT_ERROR (0, HERMITE, reinit)
 
 REINIT_ERROR (0, HERMITE, edge_reinit)
 
 SIDEMAP_ERROR (0, HERMITE, side_map)
 
 REINIT_ERROR (0, HIERARCHIC, reinit)
 
 REINIT_ERROR (0, HIERARCHIC, edge_reinit)
 
 SIDEMAP_ERROR (0, HIERARCHIC, side_map)
 
 REINIT_ERROR (0, L2_HIERARCHIC, reinit)
 
 REINIT_ERROR (0, L2_HIERARCHIC, edge_reinit)
 
 SIDEMAP_ERROR (0, L2_HIERARCHIC, side_map)
 
 REINIT_ERROR (0, LAGRANGE, reinit)
 
 REINIT_ERROR (0, LAGRANGE, edge_reinit)
 
 SIDEMAP_ERROR (0, LAGRANGE, side_map)
 
 REINIT_ERROR (0, LAGRANGE_VEC, reinit)
 
 REINIT_ERROR (0, LAGRANGE_VEC, edge_reinit)
 
 SIDEMAP_ERROR (0, LAGRANGE_VEC, side_map)
 
 REINIT_ERROR (0, L2_LAGRANGE, reinit)
 
 REINIT_ERROR (0, L2_LAGRANGE, edge_reinit)
 
 SIDEMAP_ERROR (0, L2_LAGRANGE, side_map)
 
 REINIT_ERROR (0, MONOMIAL, reinit)
 
 REINIT_ERROR (0, MONOMIAL, edge_reinit)
 
 SIDEMAP_ERROR (0, MONOMIAL, side_map)
 
 REINIT_ERROR (0, SCALAR, reinit)
 
 REINIT_ERROR (0, SCALAR, edge_reinit)
 
 SIDEMAP_ERROR (0, SCALAR, side_map)
 
 REINIT_ERROR (0, XYZ, reinit)
 
 REINIT_ERROR (0, XYZ, edge_reinit)
 
 SIDEMAP_ERROR (0, XYZ, side_map)
 
 REINIT_ERROR (0, NEDELEC_ONE, reinit)
 
 REINIT_ERROR (0, NEDELEC_ONE, edge_reinit)
 
 SIDEMAP_ERROR (0, NEDELEC_ONE, side_map)
 
 REINIT_ERROR (0, BERNSTEIN, reinit)
 
 REINIT_ERROR (0, BERNSTEIN, edge_reinit)
 
 SIDEMAP_ERROR (0, BERNSTEIN, side_map)
 
 REINIT_ERROR (0, SZABAB, reinit)
 
 REINIT_ERROR (0, SZABAB, edge_reinit)
 
 SIDEMAP_ERROR (0, SZABAB, side_map)
 
 REINIT_ERROR (1, CLOUGH, edge_reinit)
 
 REINIT_ERROR (1, HERMITE, edge_reinit)
 
 REINIT_ERROR (1, HIERARCHIC, edge_reinit)
 
 REINIT_ERROR (1, L2_HIERARCHIC, edge_reinit)
 
 REINIT_ERROR (1, LAGRANGE, edge_reinit)
 
 REINIT_ERROR (1, LAGRANGE_VEC, edge_reinit)
 
 REINIT_ERROR (1, L2_LAGRANGE, edge_reinit)
 
 REINIT_ERROR (1, XYZ, edge_reinit)
 
 REINIT_ERROR (1, MONOMIAL, edge_reinit)
 
 REINIT_ERROR (1, SCALAR, edge_reinit)
 
 REINIT_ERROR (1, NEDELEC_ONE, reinit)
 
 REINIT_ERROR (1, NEDELEC_ONE, edge_reinit)
 
 SIDEMAP_ERROR (1, NEDELEC_ONE, side_map)
 
 REINIT_ERROR (1, BERNSTEIN, edge_reinit)
 
 REINIT_ERROR (1, SZABAB, edge_reinit)
 
 INSTANTIATE_ALL_MAPS (0)
 
 INSTANTIATE_ALL_MAPS (1)
 
 INSTANTIATE_ALL_MAPS (2)
 
 INSTANTIATE_ALL_MAPS (3)
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, Elem *, Base::build_elem(const Elem *))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, Elem *, Base::build_elem(const Elem *))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, Elem *, Base::build_elem(const Elem *))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, ElemType, Base::get_elem_type(const ElemType type))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, ElemType, Base::get_elem_type(const ElemType type))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, ElemType, Base::get_elem_type(const ElemType type))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, unsigned int, Base::n_base_mapping_sf(const ElemType, const Order))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, unsigned int, Base::n_base_mapping_sf(const ElemType, const Order))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, unsigned int, Base::n_base_mapping_sf(const ElemType, const Order))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, unsigned int, Radial::n_dofs_at_node(const Order, const unsigned int))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, unsigned int, Radial::n_dofs_at_node(const Order, const unsigned int))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, unsigned int, Radial::n_dofs_at_node(const Order, const unsigned int))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, void, reinit(const Elem *, const unsigned int, const Real, const std::vector< Point > *const, const std::vector< Real > *const))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, void, reinit(const Elem *, const unsigned int, const Real, const std::vector< Point > *const, const std::vector< Real > *const))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, void, reinit(const Elem *, const unsigned int, const Real, const std::vector< Point > *const, const std::vector< Real > *const))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, void, edge_reinit(const Elem *, const unsigned int, const Real, const std::vector< Point > *const, const std::vector< Real > *const))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, void, edge_reinit(const Elem *, const unsigned int, const Real, const std::vector< Point > *const, const std::vector< Real > *const))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, void, edge_reinit(const Elem *, const unsigned int, const Real, const std::vector< Point > *const, const std::vector< Real > *const))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, void, init_face_shape_functions(const std::vector< Point > &, const Elem *))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, void, init_face_shape_functions(const std::vector< Point > &, const Elem *))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, void, init_face_shape_functions(const std::vector< Point > &, const Elem *))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, Point, map(const Elem *, const Point &))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, Point, map(const Elem *, const Point &))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, Point, map(const Elem *, const Point &))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, Point, inverse_map(const Elem *, const Point &, const Real, const bool))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, Point, inverse_map(const Elem *, const Point &, const Real, const bool))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, Point, inverse_map(const Elem *, const Point &, const Real, const bool))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, void, inverse_map(const Elem *, const std::vector< Point > &, std::vector< Point > &, const Real, const bool))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, void, inverse_map(const Elem *, const std::vector< Point > &, std::vector< Point > &, const Real, const bool))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, void, inverse_map(const Elem *, const std::vector< Point > &, std::vector< Point > &, const Real, const bool))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, unsigned int, n_dofs(const FEType &, const ElemType))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, unsigned int, n_dofs(const FEType &, const ElemType))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, unsigned int, n_dofs(const FEType &, const ElemType))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, unsigned int, n_dofs_per_elem(const FEType &, const ElemType))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, unsigned int, n_dofs_per_elem(const FEType &, const ElemType))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, unsigned int, n_dofs_per_elem(const FEType &, const ElemType))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, unsigned int, n_dofs_at_node(const FEType &, const ElemType, const unsigned int))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, unsigned int, n_dofs_at_node(const FEType &, const ElemType, const unsigned int))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, unsigned int, n_dofs_at_node(const FEType &, const ElemType, const unsigned int))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, void, compute_shape_indices(const FEType &, const ElemType, const unsigned int, unsigned int &, unsigned int &))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, void, compute_shape_indices(const FEType &, const ElemType, const unsigned int, unsigned int &, unsigned int &))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, void, compute_shape_indices(const FEType &, const ElemType, const unsigned int, unsigned int &, unsigned int &))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, void, compute_node_indices(const ElemType, const unsigned int, unsigned int &, unsigned int &))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, void, compute_node_indices(const ElemType, const unsigned int, unsigned int &, unsigned int &))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, void, compute_node_indices(const ElemType, const unsigned int, unsigned int &, unsigned int &))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, Real, shape(const FEType &, const Elem *, const unsigned int, const Point &p))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, Real, shape(const FEType &, const Elem *, const unsigned int, const Point &p))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, Real, shape(const FEType &, const Elem *, const unsigned int, const Point &p))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, Real, shape(const FEType &, const ElemType, const unsigned int, const Point &))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, Real, shape(const FEType &, const ElemType, const unsigned int, const Point &))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, Real, shape(const FEType &, const ElemType, const unsigned int, const Point &))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, void, compute_data(const FEType &, const Elem *, FEComputeData &))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, void, compute_data(const FEType &, const Elem *, FEComputeData &))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, void, compute_data(const FEType &, const Elem *, FEComputeData &))
 
 INSTANTIATE_INF_FE_MBRF (1, CARTESIAN, void, nodal_soln(const FEType &, const Elem *, const std::vector< Number > &, std::vector< Number > &))
 
 INSTANTIATE_INF_FE_MBRF (2, CARTESIAN, void, nodal_soln(const FEType &, const Elem *, const std::vector< Number > &, std::vector< Number > &))
 
 INSTANTIATE_INF_FE_MBRF (3, CARTESIAN, void, nodal_soln(const FEType &, const Elem *, const std::vector< Number > &, std::vector< Number > &))
 
bool is_between (Real min, Real check, Real max)
 
std::unique_ptr< CheckpointIOsplit_mesh (MeshBase &mesh, processor_id_type nsplits)
 
std::ostream & operator<< (std::ostream &os, const MeshBase &m)
 
void query_ghosting_functors (const MeshBase &mesh, processor_id_type pid, MeshBase::const_element_iterator elem_it, MeshBase::const_element_iterator elem_end, std::set< const Elem *, CompareElemIdsByLevel > &connected_elements)
 
void connect_children (const MeshBase &mesh, MeshBase::const_element_iterator elem_it, MeshBase::const_element_iterator elem_end, std::set< const Elem *, CompareElemIdsByLevel > &connected_elements)
 
void connect_families (std::set< const Elem *, CompareElemIdsByLevel > &connected_elements)
 
void reconnect_nodes (const std::set< const Elem *, CompareElemIdsByLevel > &connected_elements, std::set< const Node *> &connected_nodes)
 
template void MeshCommunication::find_global_indices< MeshBase::const_node_iterator > (const Parallel::Communicator &, const libMesh::BoundingBox &, const MeshBase::const_node_iterator &, const MeshBase::const_node_iterator &, std::vector< dof_id_type > &) const
 
template void MeshCommunication::find_global_indices< MeshBase::const_element_iterator > (const Parallel::Communicator &, const libMesh::BoundingBox &, const MeshBase::const_element_iterator &, const MeshBase::const_element_iterator &, std::vector< dof_id_type > &) const
 
template void MeshCommunication::find_global_indices< MeshBase::node_iterator > (const Parallel::Communicator &, const libMesh::BoundingBox &, const MeshBase::node_iterator &, const MeshBase::node_iterator &, std::vector< dof_id_type > &) const
 
template void MeshCommunication::find_global_indices< MeshBase::element_iterator > (const Parallel::Communicator &, const libMesh::BoundingBox &, const MeshBase::element_iterator &, const MeshBase::element_iterator &, std::vector< dof_id_type > &) const
 
template void MeshCommunication::find_local_indices< MeshBase::const_element_iterator > (const libMesh::BoundingBox &, const MeshBase::const_element_iterator &, const MeshBase::const_element_iterator &, std::unordered_map< dof_id_type, dof_id_type > &) const
 
 LIBMESH_VMA_INSTANTIATE (Real, int, Real)
 
 LIBMESH_VMA_INSTANTIATE (Real, float, Real)
 
 LIBMESH_VMA_INSTANTIATE (Real, double, Real)
 
 LIBMESH_VMA_INSTANTIATE (Real, int, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, int, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, int, Real)
 
 LIBMESH_VMA_INSTANTIATE (Real, float, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, float, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, float, Real)
 
 LIBMESH_VMA_INSTANTIATE (Real, std::complex< float >, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, std::complex< float >, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, std::complex< float >, Real)
 
 LIBMESH_VMA_INSTANTIATE (Real, double, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, double, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, double, Real)
 
 LIBMESH_VMA_INSTANTIATE (Real, std::complex< double >, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, std::complex< double >, Complex)
 
 LIBMESH_VMA_INSTANTIATE (Complex, std::complex< double >, Real)
 
std::ostream & operator<< (std::ostream &os, const QBase &q)
 
template<typename T >
SIGN (T a, T b)
 
double __libmesh_nlopt_objective (unsigned n, const double *x, double *gradient, void *data)
 
void __libmesh_nlopt_equality_constraints (unsigned m, double *result, unsigned n, const double *x, double *gradient, void *data)
 
void __libmesh_nlopt_inequality_constraints (unsigned m, double *result, unsigned n, const double *x, double *gradient, void *data)
 
void petsc_auto_fieldsplit (PC my_pc, const System &sys)
 
PetscErrorCode __libmesh_petsc_diff_solver_monitor (SNES snes, PetscInt its, PetscReal fnorm, void *ctx)
 
PetscErrorCode __libmesh_petsc_diff_solver_residual (SNES, Vec x, Vec r, void *ctx)
 
PetscErrorCode __libmesh_petsc_diff_solver_jacobian (SNES, Vec x, #if PETSC_RELEASE_LESS_THAN(3, 5, 0) Mat *libmesh_dbg_var(j), Mat *pc, MatStructure *msflag, #else Mat libmesh_dbg_var(j), Mat pc, #endif void *ctx)
 
DiffSolver::SolveResult convert_solve_result (SNESConvergedReason r)
 
PetscErrorCode libmesh_petsc_preconditioner_setup (void *ctx)
 
PetscErrorCode libmesh_petsc_preconditioner_apply (void *ctx, Vec x, Vec y)
 
PetscErrorCode libmesh_petsc_preconditioner_setup (PC pc)
 
PetscErrorCode libmesh_petsc_preconditioner_apply (PC pc, Vec x, Vec y)
 
PetscErrorCode __libmesh_petsc_preconditioner_setup (void *ctx)
 
PetscErrorCode __libmesh_petsc_preconditioner_apply (void *ctx, Vec x, Vec y)
 
PetscErrorCode __libmesh_petsc_preconditioner_setup (PC pc)
 
PetscErrorCode __libmesh_petsc_preconditioner_apply (PC pc, Vec x, Vec y)
 
ResidualContext libmesh_petsc_snes_residual_helper (SNES snes, Vec x, void *ctx)
 
PetscErrorCode libmesh_petsc_snes_monitor (SNES, PetscInt its, PetscReal fnorm, void *)
 
PetscErrorCode __libmesh_petsc_snes_monitor (SNES, PetscInt its, PetscReal fnorm, void *)
 
PetscErrorCode libmesh_petsc_snes_residual (SNES snes, Vec x, Vec r, void *ctx)
 
PetscErrorCode __libmesh_petsc_snes_residual (SNES snes, Vec x, Vec r, void *ctx)
 
PetscErrorCode libmesh_petsc_snes_fd_residual (SNES snes, Vec x, Vec r, void *ctx)
 
PetscErrorCode __libmesh_petsc_snes_fd_residual (SNES snes, Vec x, Vec r, void *ctx)
 
PetscErrorCode libmesh_petsc_snes_mffd_residual (SNES snes, Vec x, Vec r, void *ctx)
 
PetscErrorCode libmesh_petsc_snes_mffd_interface (void *ctx, Vec x, Vec r)
 
PetscErrorCode __libmesh_petsc_snes_mffd_interface (void *ctx, Vec x, Vec r)
 
PetscErrorCode libmesh_petsc_snes_jacobian (#if PETSC_RELEASE_LESS_THAN(3, 5, 0) SNES snes, Vec x, Mat *jac, Mat *pc, MatStructure *msflag, void *ctx #else SNES snes, Vec x, Mat jac, Mat pc, void *ctx #endif)
 
PetscErrorCode libmesh_petsc_linesearch_shellfunc (SNESLineSearch linesearch, void *ctx)
 
PetscErrorCode __libmesh_petsc_snes_jacobian (#if PETSC_RELEASE_LESS_THAN(3, 5, 0) SNES snes, Vec x, Mat *jac, Mat *pc, MatStructure *msflag, void *ctx #else SNES snes, Vec x, Mat jac, Mat pc, void *ctx #endif)
 
PetscErrorCode libmesh_petsc_snes_postcheck (#if PETSC_VERSION_LESS_THAN(3, 3, 0) SNES, Vec x, Vec y, Vec w, void *context, PetscBool *changed_y, PetscBool *changed_w #else SNESLineSearch, Vec x, Vec y, Vec w, PetscBool *changed_y, PetscBool *changed_w, void *context #endif)
 
PetscErrorCode __libmesh_petsc_snes_postcheck (#if PETSC_VERSION_LESS_THAN(3, 3, 0) SNES, Vec x, Vec y, Vec w, void *context, PetscBool *changed_y, PetscBool *changed_w #else SNESLineSearch, Vec x, Vec y, Vec w, PetscBool *changed_y, PetscBool *changed_w, void *context #endif)
 
PetscErrorCode __libmesh_tao_objective (Tao, Vec x, PetscReal *objective, void *ctx)
 
PetscErrorCode __libmesh_tao_gradient (Tao, Vec x, Vec g, void *ctx)
 
PetscErrorCode __libmesh_tao_hessian (Tao, Vec x, Mat h, Mat pc, void *ctx)
 
PetscErrorCode __libmesh_tao_equality_constraints (Tao, Vec x, Vec ce, void *ctx)
 
PetscErrorCode __libmesh_tao_equality_constraints_jacobian (Tao, Vec x, Mat J, Mat Jpre, void *ctx)
 
PetscErrorCode __libmesh_tao_inequality_constraints (Tao, Vec x, Vec cineq, void *ctx)
 
PetscErrorCode __libmesh_tao_inequality_constraints_jacobian (Tao, Vec x, Mat J, Mat Jpre, void *ctx)
 
std::ostream & operator<< (std::ostream &os, const EquationSystems &es)
 
template void Xdr::data< std::complex< float > > (std::complex< float > &, const char *)
 
template void Xdr::data< std::complex< double > > (std::complex< double > &, const char *)
 
template void Xdr::data< std::complex< long double > > (std::complex< long double > &, const char *)
 
template void Xdr::data< std::string > (std::string &, const char *)
 
template void Xdr::data< std::vector< int > > (std::vector< int > &, const char *)
 
template void Xdr::data< std::vector< unsigned int > > (std::vector< unsigned int > &, const char *)
 
template void Xdr::data< std::vector< short int > > (std::vector< short int > &, const char *)
 
template void Xdr::data< std::vector< unsigned short int > > (std::vector< unsigned short int > &, const char *)
 
template void Xdr::data< std::vector< long int > > (std::vector< long int > &, const char *)
 
template void Xdr::data< std::vector< long long > > (std::vector< long long > &, const char *)
 
template void Xdr::data< std::vector< unsigned long int > > (std::vector< unsigned long int > &, const char *)
 
template void Xdr::data< std::vector< unsigned long long > > (std::vector< unsigned long long > &, const char *)
 
template void Xdr::data< std::vector< char > > (std::vector< char > &, const char *)
 
template void Xdr::data< std::vector< signed char > > (std::vector< signed char > &, const char *)
 
template void Xdr::data< std::vector< unsigned char > > (std::vector< unsigned char > &, const char *)
 
template void Xdr::data< std::vector< float > > (std::vector< float > &, const char *)
 
template void Xdr::data< std::vector< double > > (std::vector< double > &, const char *)
 
template void Xdr::data< std::vector< long double > > (std::vector< long double > &, const char *)
 
template void Xdr::data< std::vector< std::complex< float > > > (std::vector< std::complex< float >> &, const char *)
 
template void Xdr::data< std::vector< std::complex< double > > > (std::vector< std::complex< double >> &, const char *)
 
template void Xdr::data< std::vector< std::complex< long double > > > (std::vector< std::complex< long double >> &, const char *)
 
template void Xdr::data< std::vector< std::string > > (std::vector< std::string > &, const char *)
 
template<typename T , typename... Args>
std::unique_ptr< T > make_unique (Args &&... args)
 
 ScalarTraits_true (char)
 
 ScalarTraits_true (short)
 
 ScalarTraits_true (int)
 
 ScalarTraits_true (long)
 
 ScalarTraits_true (unsigned char)
 
 ScalarTraits_true (float)
 
 ScalarTraits_true (double)
 
 SUPERTYPE (unsigned char, short)
 
 SUPERTYPE (unsigned char, int)
 
 SUPERTYPE (unsigned char, float)
 
 SUPERTYPE (unsigned char, double)
 
 SUPERTYPE (unsigned char, long double)
 
 SUPERTYPE (char, short)
 
 SUPERTYPE (char, int)
 
 SUPERTYPE (char, float)
 
 SUPERTYPE (char, double)
 
 SUPERTYPE (char, long double)
 
 SUPERTYPE (short, int)
 
 SUPERTYPE (short, float)
 
 SUPERTYPE (short, double)
 
 SUPERTYPE (short, long double)
 
 SUPERTYPE (int, float)
 
 SUPERTYPE (int, double)
 
 SUPERTYPE (int, long double)
 
 SUPERTYPE (float, double)
 
 SUPERTYPE (float, long double)
 
 SUPERTYPE (double, long double)
 
std::ostream & operator<< (std::ostream &os, const Elem &e)
 
bool operator== (const OrderWrapper &lhs, const OrderWrapper &rhs)
 
bool operator!= (const OrderWrapper &lhs, const OrderWrapper &rhs)
 
bool operator< (const OrderWrapper &lhs, const OrderWrapper &rhs)
 
bool operator> (const OrderWrapper &lhs, const OrderWrapper &rhs)
 
bool operator<= (const OrderWrapper &lhs, const OrderWrapper &rhs)
 
bool operator>= (const OrderWrapper &lhs, const OrderWrapper &rhs)
 
 OrderWrapperOperators (int) OrderWrapperOperators(unsigned int) OrderWrapperOperators(std
 
bool operator== (const OrderWrapper &lhs, int rhs)
 
bool operator== (Order lhs, const OrderWrapper &rhs)
 
bool operator== (const OrderWrapper &lhs, Order rhs)
 
bool operator!= (int lhs, const OrderWrapper &rhs)
 
bool operator!= (const OrderWrapper &lhs, int rhs)
 
bool operator!= (Order lhs, const OrderWrapper &rhs)
 
bool operator!= (const OrderWrapper &lhs, Order rhs)
 
bool operator< (int lhs, const OrderWrapper &rhs)
 
bool operator< (const OrderWrapper &lhs, int rhs)
 
bool operator< (Order lhs, const OrderWrapper &rhs)
 
bool operator< (const OrderWrapper &lhs, Order rhs)
 
bool operator> (int lhs, const OrderWrapper &rhs)
 
bool operator> (const OrderWrapper &lhs, int rhs)
 
bool operator> (Order lhs, const OrderWrapper &rhs)
 
bool operator> (const OrderWrapper &lhs, Order rhs)
 
bool operator<= (int lhs, const OrderWrapper &rhs)
 
bool operator<= (const OrderWrapper &lhs, int rhs)
 
bool operator<= (Order lhs, const OrderWrapper &rhs)
 
bool operator<= (const OrderWrapper &lhs, Order rhs)
 
bool operator>= (int lhs, const OrderWrapper &rhs)
 
bool operator>= (const OrderWrapper &lhs, int rhs)
 
bool operator>= (Order lhs, const OrderWrapper &rhs)
 
bool operator>= (const OrderWrapper &lhs, Order rhs)
 
std::ostream & operator<< (std::ostream &os, const OrderWrapper &order)
 
 INSTANTIATE_INF_FE (1, CARTESIAN)
 
 INSTANTIATE_INF_FE (2, CARTESIAN)
 
 INSTANTIATE_INF_FE (3, CARTESIAN)
 
template<typename T >
IntRange< std::size_t > index_range (const std::vector< T > &vec)
 
template<typename T >
IntRange< numeric_index_typeindex_range (const NumericVector< T > &vec)
 
processor_id_type global_n_processors ()
 
processor_id_type global_processor_id ()
 
unsigned int n_threads ()
 
template<typename T >
libmesh_real (T a)
 
template<typename T >
libmesh_conj (T a)
 
template<typename T >
libmesh_real (std::complex< T > a)
 
template<typename T >
std::complex< T > libmesh_conj (std::complex< T > a)
 
bool libmesh_isnan (float a)
 
bool libmesh_isnan (double a)
 
bool libmesh_isnan (long double a)
 
template<typename T >
bool libmesh_isnan (std::complex< T > a)
 
template<typename T >
bool libmesh_isinf (T x)
 
template<typename T >
bool libmesh_isinf (std::complex< T > a)
 
template<class ... Args>
void libmesh_ignore (const Args &...)
 
template<typename Tnew , typename Told >
Tnew cast_ref (Told &oldvar)
 
template<typename Tnew , typename Told >
Tnew libmesh_cast_ref (Told &oldvar)
 
template<typename Tnew , typename Told >
Tnew cast_ptr (Told *oldvar)
 
template<typename Tnew , typename Told >
Tnew libmesh_cast_ptr (Told *oldvar)
 
template<typename Tnew , typename Told >
Tnew cast_int (Told oldvar)
 
template<typename Tnew , typename Told >
Tnew libmesh_cast_int (Told oldvar)
 
void libmesh_version_stdout ()
 
int get_libmesh_version ()
 
std::string get_io_compatibility_version ()
 
std::ostream & operator<< (std::ostream &os, const Node &n)
 
template<typename P >
void print_helper (std::ostream &os, const P *param)
 
template<typename P >
void print_helper (std::ostream &os, const std::vector< P > *param)
 
template<typename P >
void print_helper (std::ostream &os, const std::vector< std::vector< P >> *param)
 
std::ostream & operator<< (std::ostream &os, const Parameters &p)
 
template<>
void print_helper (std::ostream &os, const char *param)
 
template<>
void print_helper (std::ostream &os, const unsigned char *param)
 
PetscErrorCode libmesh_petsc_snes_jacobian (SNES, Vec x, Mat *jac, Mat *pc, MatStructure *msflag, void *ctx)
 
PetscErrorCode libmesh_petsc_snes_jacobian (SNES, Vec x, Mat jac, Mat pc, void *ctx)
 
PetscErrorCode __libmesh_petsc_snes_jacobian (SNES, Vec x, Mat *jac, Mat *pc, MatStructure *msflag, void *ctx)
 
PetscErrorCode __libmesh_petsc_snes_jacobian (SNES, Vec x, Mat jac, Mat pc, void *ctx)
 
PetscInt * numeric_petsc_cast (const numeric_index_type *p)
 
template<typename I >
SimpleRange< I > as_range (const std::pair< I, I > &p)
 
template<typename I >
SimpleRange< I > as_range (const I &first, const I &second)
 
template<typename T >
std::ostream & operator<< (std::ostream &os, const SparseMatrix< T > &m)
 
int * numeric_trilinos_cast (const numeric_index_type *p)
 
template<unsigned int N, typename T , typename Scalar >
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeNTensor< N, typename CompareTypes< Scalar, T >::supertype > >::type operator* (const Scalar &, const TypeNTensor< N, T > &)
 
template<unsigned int N, typename T , typename Scalar >
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeNTensor< N, typename CompareTypes< Scalar, T >::supertype > >::type operator/ (const Scalar &, const TypeNTensor< N, T > &)
 
template<typename T , typename Scalar >
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeTensor< typename CompareTypes< T, Scalar >::supertype > >::type operator* (const Scalar factor, const TypeTensor< T > &t)
 
template<typename T , typename Scalar >
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< T, Scalar >::supertype > >::type operator* (const Scalar factor, const TypeVector< T > &v)
 
template<typename T >
triple_product (const TypeVector< T > &a, const TypeVector< T > &b, const TypeVector< T > &c)
 
template<typename T >
cross_norm_sq (const TypeVector< T > &b, const TypeVector< T > &c)
 
template<typename T >
cross_norm (const TypeVector< T > &b, const TypeVector< T > &c)
 

Variables

DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
 
DIE A HORRIBLE DEATH HERE typedef float ErrorVectorReal
 
MPI_Comm GLOBAL_COMM_WORLD = MPI_COMM_NULL
 
OStreamProxy out (std::cout)
 
OStreamProxy err (std::cerr)
 
PerfLog perflog ("libMesh", #ifdef LIBMESH_ENABLE_PERFORMANCE_LOGGING true #else false #endif)
 
MPI_Errhandler libmesh_errhandler
 
 TRILINOS_SOLVERS
 
 EIGEN_SOLVERS
 
 LASPACK_SOLVERS
 
 INVALID_SOLVER_PACKAGE
 
std::terminate_handler old_terminate_handler
 
 INSTANTIATE_SUBDIVISION_FE
 
 INSTANTIATE_SUBDIVISION_MAPS
 
Threads::spin_mutex parent_indices_mutex
 
Threads::spin_mutex parent_bracketing_nodes_mutex
 
const RemoteElemremote_elem
 
const unsigned int MIN_ELEM_PER_PROC = 4
 
const unsigned char triangular_number_row []
 
const unsigned char triangular_number_column []
 
const unsigned char square_number_column []
 
const unsigned char square_number_row []
 
const unsigned char cube_number_column []
 
const unsigned char cube_number_row []
 
const unsigned char cube_number_page []
 
const Number imaginary
 
const Real pi
 
const Number zero = 0.
 
const unsigned int invalid_uint = static_cast<unsigned int>(-1)
 
static const Real TOLERANCE = 1.e-8
 
bool warned_about_auto_ptr
 

Detailed Description

Sanity check, without prior inclusion of libmesh_config.h.

This file is no typical header file. It is only to be included at the end of an implementation file, so that the proper variations of the InfFE class are instantiated.

The libMesh namespace provides an interface to certain functionality in the library. Here, it provides a LibMeshInit class which uses the RAII (Resource Acquisition Is Initialization) idiom to ensure initialization of any other dependent libraries (e.g. MPI or PETSC), and to close those libraries when it goes out of scope. It also provides a centralized place for performance logging and other functionality.

Typedef Documentation

◆ boundary_id_type

typedef int16_t libMesh::boundary_id_type

Definition at line 51 of file id_types.h.

◆ Complex

typedef std::complex<Real> libMesh::Complex

Definition at line 155 of file libmesh_common.h.

◆ COMPLEX

typedef std::complex<Real> libMesh::COMPLEX

Definition at line 156 of file libmesh_common.h.

◆ ConstElemRange

◆ ConstNodeRange

◆ DefaultMesh

Definition at line 28 of file mesh.h.

◆ dof_id_type

typedef uint32_t libMesh::dof_id_type

Definition at line 64 of file id_types.h.

◆ DofConstraintRow

A row of the Dof constraint matrix.

Definition at line 97 of file dof_map.h.

◆ DSNAN

typedef DynamicSparseNumberArray<Real, dof_id_type> libMesh::DSNAN

Definition at line 96 of file system_projection.C.

◆ eigen_idx_type

typedef int32_t libMesh::eigen_idx_type

Definition at line 66 of file eigen_core_support.h.

◆ EigenSM

typedef Eigen::SparseMatrix<Number, Eigen::RowMajor, eigen_idx_type> libMesh::EigenSM

Definition at line 78 of file eigen_core_support.h.

◆ EigenSV

typedef Eigen::Matrix<Number, Eigen::Dynamic, 1> libMesh::EigenSV

Definition at line 79 of file eigen_core_support.h.

◆ ElemRange

◆ FEBase

Definition at line 39 of file exact_error_estimator.h.

◆ FEVectorBase

Definition at line 667 of file fe_base.h.

◆ Gradient

Definition at line 57 of file exact_solution.h.

◆ largest_id_type

typedef uint8_t libMesh::largest_id_type

Definition at line 139 of file id_types.h.

◆ NodeConstraintRow

typedef std::map<const Node *, Real, std::less<const Node *>, Threads::scalable_allocator<std::pair<const Node * const, Real> > > libMesh::NodeConstraintRow

A row of the Node constraint mapping. Currently this just stores the topology of the constrained Nodes, but for forward compatibility we also include coefficients, so we could add Lagrange-positioned-node constraints later.

Definition at line 145 of file dof_map.h.

◆ NodeRange

Definition at line 31 of file node_range.h.

◆ Number

Definition at line 191 of file libmesh_common.h.

◆ NumberTensorValue

Definition at line 53 of file exact_solution.h.

◆ NumberVectorValue

Definition at line 56 of file exact_solution.h.

◆ numeric_index_type

Definition at line 92 of file id_types.h.

◆ OStreamProxy

Definition at line 232 of file ostream_proxy.h.

◆ processor_id_type

typedef uint16_t libMesh::processor_id_type

Definition at line 99 of file id_types.h.

◆ REAL

Definition at line 44 of file mesh_triangle_wrapper.h.

◆ RealGradient

Definition at line 50 of file hp_coarsentest.h.

◆ RealTensor

Definition at line 51 of file hp_coarsentest.h.

◆ RealTensorValue

Useful typedefs to allow transparent switching between Real and Complex data types.

Definition at line 49 of file hp_coarsentest.h.

◆ RealVectorValue

Useful typedefs to allow transparent switching between Real and Complex data types.

Definition at line 47 of file hp_coarsentest.h.

◆ SteadyLinearSystem

◆ subdomain_id_type

typedef uint16_t libMesh::subdomain_id_type
Note
subdomain_id_type should be a positive integer, but due to a limitation in the exodusII API, we are forced to use a signed integer here to represent subdomains. This gives us 2^31 possible unique blocks.

Based on the 4-byte comment warning above, this probably doesn't work with exodusII at all...

Definition at line 43 of file id_types.h.

◆ Tensor

Definition at line 55 of file exact_solution.h.

◆ TransientBaseSystem

◆ TransientEigenSystem

◆ TransientExplicitSystem

◆ TransientImplicitSystem

◆ TransientLinearImplicitSystem

◆ TransientNonlinearImplicitSystem

◆ tuple_of

template<size_t I, typename T >
using libMesh::tuple_of = typedef typename tuple_n<I,T>::template type<>

Definition at line 21 of file tuple_of.h.

◆ unique_id_type

typedef uint64_t libMesh::unique_id_type

Definition at line 79 of file id_types.h.

◆ UniquePtr

template<typename T >
using libMesh::UniquePtr = typedef std::unique_ptr<T>

Definition at line 33 of file auto_ptr.h.

◆ unordered_multiset_elem

typedef std::unordered_multiset<Elem *, ElemHashUtils, ElemHashUtils> libMesh::unordered_multiset_elem

Definition at line 77 of file elem_hash.h.

Enumeration Type Documentation

◆ EigenProblemType

Defines an enum for eigenproblem types. This can be Hermitian (HEP), generalized Hermitian (GHEP), non-Hermitian (NHEP), generalized non-Hermitian (GNHEP), or generalized indefinite Hermitian (GHIEP).

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum EigenProblemType : int; reducing header file dependencies.

Enumerator
NHEP 
HEP 
GNHEP 
GHEP 
GHIEP 
INVALID_EIGENPROBLEMTYPE 

Definition at line 54 of file enum_eigen_solver_type.h.

◆ EigenSolverType

Defines an enum for iterative eigenproblem solver types

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum EigenSolverType : int; reducing header file dependencies.

Enumerator
POWER 
LAPACK 
SUBSPACE 
ARNOLDI 
LANCZOS 
KRYLOVSCHUR 
INVALID_EIGENSOLVER 

Definition at line 33 of file enum_eigen_solver_type.h.

◆ ElemQuality

Defines an enum for element quality metrics.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum ElemQuality : int; reducing header file dependencies.

Enumerator
ASPECT_RATIO 
SKEW 
SHEAR 
SHAPE 
MAX_ANGLE 
MIN_ANGLE 
CONDITION 
DISTORTION 
TAPER 
WARP 
STRETCH 
DIAGONAL 
ASPECT_RATIO_BETA 
ASPECT_RATIO_GAMMA 
SIZE 
JACOBIAN 

Definition at line 34 of file enum_elem_quality.h.

◆ ElemType

enum libMesh::ElemType : int

Defines an enum for geometric element types.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum ElemType : int; reducing header file dependencies.

Enumerator
EDGE2 
EDGE3 
EDGE4 
TRI3 
TRI6 
QUAD4 
QUAD8 
QUAD9 
TET4 
TET10 
HEX8 
HEX20 
HEX27 
PRISM6 
PRISM15 
PRISM18 
PYRAMID5 
PYRAMID13 
PYRAMID14 
INFEDGE2 
INFQUAD4 
INFQUAD6 
INFHEX8 
INFHEX16 
INFHEX18 
INFPRISM6 
INFPRISM12 
NODEELEM 
REMOTEELEM 
TRI3SUBDIVISION 
TRISHELL3 
QUADSHELL4 
QUADSHELL8 
INVALID_ELEM 

Definition at line 33 of file enum_elem_type.h.

33  : int {
34  // 1D
35  EDGE2 = 0,
36  EDGE3 = 1,
37  EDGE4 = 2,
38  // 2D
39  TRI3 = 3,
40  TRI6 = 4,
41  QUAD4 = 5,
42  QUAD8 = 6,
43  QUAD9 = 7,
44  // 3D
45  TET4 = 8,
46  TET10 = 9,
47  HEX8 = 10,
48  HEX20 = 11,
49  HEX27 = 12,
50  PRISM6 = 13,
51  PRISM15 = 14,
52  PRISM18 = 15,
53  PYRAMID5 = 16,
54  PYRAMID13 = 17,
55  PYRAMID14 = 18,
56  // Infinite Elems
57  INFEDGE2 = 19,
58  INFQUAD4 = 20,
59  INFQUAD6 = 21,
60  INFHEX8 = 22,
61  INFHEX16 = 23,
62  INFHEX18 = 24,
63  INFPRISM6 = 25,
64  INFPRISM12 = 26,
65  // 0D
66  NODEELEM = 27,
67  // Miscellaneous Elems
68  REMOTEELEM = 28,
69  TRI3SUBDIVISION = 29,
70  // Shell Elems
71  TRISHELL3 = 30,
72  QUADSHELL4 = 31,
73  QUADSHELL8 = 32,
74  // Invalid
75  INVALID_ELEM}; // should always be last

◆ ErrorEstimatorType

Defines an enum for the different types of error estimators which are available.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum ErrorEstimatorType : int; reducing header file dependencies.

Enumerator
INVALID 
ADJOINT_REFINEMENT 
ADJOINT_RESIDUAL 
DISCONTINUITY_MEASURE 
EXACT 
KELLY 
LAPLACIAN 
PATCH_RECOVERY 
WEIGHTED_PATCH_RECOVERY 
UNIFORM_REFINEMENT 

Definition at line 33 of file enum_error_estimator_type.h.

◆ FEContinuity

defines an enum for finite element types to libmesh_assert a certain level (or type? Hcurl?) of continuity.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum FEContinuity : int; reducing header file dependencies.

Enumerator
DISCONTINUOUS 
C_ZERO 
C_ONE 
H_CURL 

Definition at line 74 of file enum_fe_family.h.

◆ FEFamily

enum libMesh::FEFamily : int

defines an enum for finite element families.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum FEFamily : int; reducing header file dependencies.

Enumerator
LAGRANGE 
HIERARCHIC 
MONOMIAL 
L2_HIERARCHIC 
L2_LAGRANGE 
BERNSTEIN 
SZABAB 
XYZ 
INFINITE_MAP 
JACOBI_20_00 
JACOBI_30_00 
LEGENDRE 
CLOUGH 
HERMITE 
SUBDIVISION 
SCALAR 
LAGRANGE_VEC 
NEDELEC_ONE 
INVALID_FE 

Definition at line 34 of file enum_fe_family.h.

34  : int {
35  // C0
36  LAGRANGE = 0,
37  HIERARCHIC = 1,
38  // discontinuous, in local coordinates
39  MONOMIAL = 2,
40  L2_HIERARCHIC = 6,
41  L2_LAGRANGE = 7,
42  // higher-order
43  BERNSTEIN = 3,
44  SZABAB = 4,
45  // discontinuous, in global coordinates
46  XYZ = 5,
47  // infinite element stuff
48  INFINITE_MAP = 11, // for 1/r-map
49  JACOBI_20_00 = 12, // i_max = 19
50  JACOBI_30_00 = 13, // i_max = 19
51  LEGENDRE = 14, // i_max = 19
52  // C1 elements
53  CLOUGH = 21,
54  HERMITE = 22,
55  SUBDIVISION = 23,
56  // A scalar variable that couples to
57  // all other DOFs in the system
58  SCALAR = 31,
59  // Vector-valued elements
60  LAGRANGE_VEC = 41,
61  NEDELEC_ONE = 42,
62  // Invalid
63  INVALID_FE = 99};

◆ FEFieldType

defines an enum for finite element field types - i.e. is it a scalar element, vector, tensor, etc.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum FEFieldType : int; reducing header file dependencies.

Enumerator
TYPE_SCALAR 
TYPE_VECTOR 

Definition at line 89 of file enum_fe_family.h.

◆ FEMNormType

defines an enum for norms defined on vectors of finite element coefficients

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum FEMNormType : int; reducing header file dependencies.

Enumerator
L2 
H1 
H2 
HCURL 
HDIV 
L1 
L_INF 
H1_SEMINORM 
H2_SEMINORM 
HCURL_SEMINORM 
HDIV_SEMINORM 
W1_INF_SEMINORM 
W2_INF_SEMINORM 
DISCRETE_L1 
DISCRETE_L2 
DISCRETE_L_INF 
H1_X_SEMINORM 
H1_Y_SEMINORM 
H1_Z_SEMINORM 
INVALID_NORM 

Definition at line 34 of file enum_norm_type.h.

34  : int {
35  // Hilbert norms and seminorms in FE space
36  L2 = 0,
37  H1 = 1,
38  H2 = 2,
39  HCURL = 3,
40  HDIV = 4,
41  L1 = 5,
42  L_INF = 6,
43  H1_SEMINORM = 10,
44  H2_SEMINORM = 11,
45  // Vector FE norms
46  HCURL_SEMINORM = 12,
47  HDIV_SEMINORM = 13,
48  // Sobolev infinity seminorms
49  W1_INF_SEMINORM = 15,
50  W2_INF_SEMINORM = 16,
51  // discrete norms on coefficient vectors
52  DISCRETE_L1 = 20,
53  DISCRETE_L2 = 21,
54  DISCRETE_L_INF = 22,
55  // Seminorms based on only individual gradient
56  // directional components
57  H1_X_SEMINORM = 31,
58  H1_Y_SEMINORM = 32,
59  H1_Z_SEMINORM = 33,
60  // Invalid
61  INVALID_NORM = 42};

◆ InfMapType

enum libMesh::InfMapType : int

defines an enum for the types of coordinate mappings available in infinite elements.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum InfMapType : int; reducing header file dependencies.

Enumerator
CARTESIAN 
SPHERICAL 
ELLIPSOIDAL 
INVALID_INF_MAP 

Definition at line 34 of file enum_inf_map_type.h.

◆ IOPackage

enum libMesh::IOPackage : int

libMesh interfaces with several different software packages for the purposes of creating, reading, and writing mesh files. These enumerations give an easy way of selecting one or the other.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum IOPackage : int; reducing header file dependencies.

Enumerator
TECPLOT 
GMV 
GMSH 
VTK 
DIVA 
TETGEN 
UCD 
LIBMESH 
INVALID_IO_PACKAGE 

Definition at line 37 of file enum_io_package.h.

◆ LinearConvergenceReason

Linear solver convergence flags (taken from the PETSc flags).

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum LinearConvergenceReason : int; reducing header file dependencies.

Enumerator
CONVERGED_RTOL_NORMAL 
CONVERGED_ATOL_NORMAL 
CONVERGED_RTOL 
CONVERGED_ATOL 
CONVERGED_ITS 
CONVERGED_CG_NEG_CURVE 
CONVERGED_CG_CONSTRAINED 
CONVERGED_STEP_LENGTH 
CONVERGED_HAPPY_BREAKDOWN 
DIVERGED_NULL 
DIVERGED_ITS 
DIVERGED_DTOL 
DIVERGED_BREAKDOWN 
DIVERGED_BREAKDOWN_BICG 
DIVERGED_NONSYMMETRIC 
DIVERGED_INDEFINITE_PC 
DIVERGED_NAN 
DIVERGED_INDEFINITE_MAT 
DIVERGED_PCSETUP_FAILED 
CONVERGED_ITERATING 
UNKNOWN_FLAG 

Definition at line 33 of file enum_convergence_flags.h.

33  : int {
34  // converged
37  CONVERGED_RTOL = 2,
38  CONVERGED_ATOL = 3,
39  CONVERGED_ITS = 4,
44  // diverged
45  DIVERGED_NULL = -2,
46  DIVERGED_ITS = -3,
47  DIVERGED_DTOL = -4,
48  DIVERGED_BREAKDOWN = -5,
52  DIVERGED_NAN = -9,
55  // still running
57  // Invalid
58  UNKNOWN_FLAG = -128};

◆ Order

enum libMesh::Order : int

defines an enum for polynomial orders. Fixing each label to a specific int, since InfFE and p refinement may cast between them.

Note
It is possible to safely cast integral values larger than 43 to Order, provided that the cast value fits in the range of int. A potential use case for such a cast is when employing the QGrid class at extremely high order.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum Order : int; reducing header file dependencies.

Enumerator
CONSTANT 
FIRST 
SECOND 
THIRD 
FOURTH 
FIFTH 
SIXTH 
SEVENTH 
EIGHTH 
NINTH 
TENTH 
ELEVENTH 
TWELFTH 
THIRTEENTH 
FOURTEENTH 
FIFTEENTH 
SIXTEENTH 
SEVENTEENTH 
EIGHTTEENTH 
NINETEENTH 
TWENTIETH 
TWENTYFIRST 
TWENTYSECOND 
TWENTYTHIRD 
TWENTYFOURTH 
TWENTYFIFTH 
TWENTYSIXTH 
TWENTYSEVENTH 
TWENTYEIGHTH 
TWENTYNINTH 
THIRTIETH 
THIRTYFIRST 
THIRTYSECOND 
THIRTYTHIRD 
THIRTYFOURTH 
THIRTYFIFTH 
THIRTYSIXTH 
THIRTYSEVENTH 
THIRTYEIGHTH 
THIRTYNINTH 
FORTIETH 
FORTYFIRST 
FORTYSECOND 
FORTYTHIRD 
INVALID_ORDER 

Definition at line 40 of file enum_order.h.

40  : int {
41  CONSTANT = 0,
42  FIRST = 1,
43  SECOND = 2,
44  THIRD = 3,
45  FOURTH = 4,
46  FIFTH = 5,
47  SIXTH = 6,
48  SEVENTH = 7,
49  EIGHTH = 8,
50  NINTH = 9,
51  TENTH = 10,
52  ELEVENTH = 11,
53  TWELFTH = 12,
54  THIRTEENTH = 13,
55  FOURTEENTH = 14,
56  FIFTEENTH = 15,
57  SIXTEENTH = 16,
58  SEVENTEENTH = 17,
59  EIGHTTEENTH = 18,
60  NINETEENTH = 19,
61  TWENTIETH = 20,
62  TWENTYFIRST = 21,
63  TWENTYSECOND = 22,
64  TWENTYTHIRD = 23,
65  TWENTYFOURTH = 24,
66  TWENTYFIFTH = 25,
67  TWENTYSIXTH = 26,
68  TWENTYSEVENTH = 27,
69  TWENTYEIGHTH = 28,
70  TWENTYNINTH = 29,
71  THIRTIETH = 30,
72  THIRTYFIRST = 31,
73  THIRTYSECOND = 32,
74  THIRTYTHIRD = 33,
75  THIRTYFOURTH = 34,
76  THIRTYFIFTH = 35,
77  THIRTYSIXTH = 36,
78  THIRTYSEVENTH = 37,
79  THIRTYEIGHTH = 38,
80  THIRTYNINTH = 39,
81  FORTIETH = 40,
82  FORTYFIRST = 41,
83  FORTYSECOND = 42,
84  FORTYTHIRD = 43,
85  // Invalid

◆ ParallelType

Defines an enum for parallel data structure types.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum ParallelType : int; reducing header file dependencies.

Enumerator
AUTOMATIC 
SERIAL 
PARALLEL 
GHOSTED 
INVALID_PARALLELIZATION 

Definition at line 33 of file enum_parallel_type.h.

◆ PetscMatrixType

Enumerator
AIJ 
HYPRE 

Definition at line 63 of file petsc_matrix.h.

63  : int {
64  AIJ=0,
65  HYPRE};

◆ PointLocatorType

defines an enum for the types of point locators (given a point with global coordinates, locate the corresponding element in space) available in libMesh.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum PointLocatorType : int; reducing header file dependencies.

Enumerator
TREE 
TREE_ELEMENTS 
TREE_LOCAL_ELEMENTS 
INVALID_LOCATOR 

Definition at line 35 of file enum_point_locator_type.h.

◆ PositionOfSpectrum

Defines an enum for the position of the spectrum, i.e. the eigenvalues to be computed.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum PositionOfSpectrum : int; reducing header file dependencies.

Enumerator
LARGEST_MAGNITUDE 
SMALLEST_MAGNITUDE 
TARGET_MAGNITUDE 
LARGEST_REAL 
SMALLEST_REAL 
TARGET_REAL 
LARGEST_IMAGINARY 
SMALLEST_IMAGINARY 
TARGET_IMAGINARY 
INVALID_Postion_of_Spectrum 
INVALID_POSITION_OF_SPECTRUM 

Definition at line 74 of file enum_eigen_solver_type.h.

◆ PreconditionerType

Defines an enum for preconditioner types.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum PreconditionerType : int; reducing header file dependencies.

Enumerator
IDENTITY_PRECOND 
JACOBI_PRECOND 
BLOCK_JACOBI_PRECOND 
SOR_PRECOND 
SSOR_PRECOND 
EISENSTAT_PRECOND 
ASM_PRECOND 
CHOLESKY_PRECOND 
ICC_PRECOND 
ILU_PRECOND 
LU_PRECOND 
USER_PRECOND 
SHELL_PRECOND 
AMG_PRECOND 
INVALID_PRECONDITIONER 

Definition at line 33 of file enum_preconditioner_type.h.

◆ QuadratureType

Defines an enum for currently available quadrature rules.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum QuadratureType : int; reducing header file dependencies.

Enumerator
QGAUSS 
QJACOBI_1_0 
QJACOBI_2_0 
QSIMPSON 
QTRAP 
QGRID 
QGRUNDMANN_MOLLER 
QMONOMIAL 
QCONICAL 
QGAUSS_LOBATTO 
QCLOUGH 
QCOMPOSITE 
INVALID_Q_RULE 

Definition at line 33 of file enum_quadrature_type.h.

◆ SolverPackage

Defines an enum for various linear solver packages. This allows for run-time switching between solver packages

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum SolverPackage : int; reducing header file dependencies.

Enumerator
PETSC_SOLVERS 
SLEPC_SOLVERS 
NLOPT_SOLVERS 

Definition at line 34 of file enum_solver_package.h.

◆ SolverType

enum libMesh::SolverType : int

Defines an enum for iterative solver types.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum SolverType : int; reducing header file dependencies.

Enumerator
CG 
CGN 
CGS 
CR 
QMR 
TCQMR 
TFQMR 
BICG 
BICGSTAB 
MINRES 
GMRES 
LSQR 
JACOBI 
SOR_FORWARD 
SOR_BACKWARD 
SSOR 
RICHARDSON 
CHEBYSHEV 
SPARSELU 
INVALID_SOLVER 

Definition at line 33 of file enum_solver_type.h.

◆ SubsetSolveMode

defines an enum for the question what happens to the dofs outside the given subset when a system is solved on a subset.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum SubsetSolveMode : int; reducing header file dependencies.

Enumerator
SUBSET_ZERO 
SUBSET_COPY_RHS 
SUBSET_DONT_TOUCH 

Definition at line 35 of file enum_subset_solve_mode.h.

35  : int {
36  // Set dofs outside the subset to zero.
37  SUBSET_ZERO = 0,
38  // Set dofs outside the subset to the value of the corresponding
39  // dofs of the right hand side.
41  // Leaves dofs outside the subset unchanged. This is fastest, but
42  // also most confusing because it abandons the property that the
43  // solution vector is (theoretically) independent of the initial
44  // guess.
46 };

◆ VariableIndexing

Dirichlet functions may be indexed either by "system variable order" or "local variable order", depending on how the DirichletBoundary object is constructed. For example, suppose a system has variables {a, b, c, d}, and a DirichletBoundary is set for variables {b, d} (i.e. variables_in is {1, 3}). If the boundary is constructed to use "system variable order", input function(s) will be queried for components 1 and 3; this is useful for reusing input functions as both exact solutions and Dirichlet boundaries in benchmark problems. If the boundary is constructed to use "local variable order", input function(s) will be queried for components 0 and 1; this is useful for flexibly constructing Dirichlet boundaries in multiphysics codes or from user input files.

Enumerator
SYSTEM_VARIABLE_ORDER 
LOCAL_VARIABLE_ORDER 

Definition at line 62 of file dirichlet_boundaries.h.

◆ XdrMODE

enum libMesh::XdrMODE : int

Defines an enum for read/write mode in Xdr format. READ, WRITE perform reading and writing in ASCII format, and DECODE, ENCODE do the same in binary format.

The fixed type, i.e. ": int", enumeration syntax used here allows this enum to be forward declared as enum XdrMODE : int; reducing header file dependencies.

Enumerator
UNKNOWN 
ENCODE 
DECODE 
WRITE 
READ 

Definition at line 35 of file enum_xdr_mode.h.

35  : int
36  {
37  UNKNOWN = -1,
38  ENCODE=0,
39  DECODE,
40  WRITE,
41  READ
42  };

Function Documentation

◆ __libmesh_nlopt_equality_constraints()

void libMesh::__libmesh_nlopt_equality_constraints ( unsigned  m,
double *  result,
unsigned  n,
const double *  x,
double *  gradient,
void *  data 
)

Definition at line 107 of file nlopt_optimization_solver.C.

References data, libMesh::OptimizationSystem::ComputeEqualityConstraints::equality_constraints(), libMesh::OptimizationSystem::ComputeEqualityConstraintsJacobian::equality_constraints_jacobian(), libMesh::OptimizationSolver< T >::equality_constraints_jacobian_object, libMesh::OptimizationSolver< T >::equality_constraints_object, index_range(), and libMesh::OptimizationSolver< T >::system().

Referenced by libMesh::NloptOptimizationSolver< T >::solve().

113 {
114  LOG_SCOPE("equality_constraints()", "NloptOptimizationSolver");
115 
116  libmesh_assert(data);
117 
118  // data should be a pointer to the solver (it was passed in as void *)
119  NloptOptimizationSolver<Number> * solver =
120  static_cast<NloptOptimizationSolver<Number> *> (data);
121 
122  OptimizationSystem & sys = solver->system();
123 
124  // We'll use current_local_solution below, so let's ensure that it's consistent
125  // with the vector x that was passed in.
126  if (sys.solution->size() != n)
127  libmesh_error_msg("Error: Input vector x has different length than sys.solution!");
128 
129  for (auto i : index_range(*sys.solution))
130  sys.solution->set(i, x[i]);
131  sys.solution->close();
132 
133  // Impose constraints on the solution vector
134  sys.get_dof_map().enforce_constraints_exactly(sys);
135 
136  // Update sys.current_local_solution based on the solution vector
137  sys.update();
138 
139  // Call the user's equality constraints function if there is one.
140  OptimizationSystem::ComputeEqualityConstraints * eco = solver->equality_constraints_object;
141  if (eco)
142  {
143  eco->equality_constraints(*sys.current_local_solution,
144  *sys.C_eq,
145  sys);
146 
147  sys.C_eq->close();
148 
149  // Copy the values out of eq_constraints into 'result'.
150  // TODO: Even better would be if we could use 'result' directly
151  // as the storage of eq_constraints. Perhaps a serial-only
152  // NumericVector variant which supports this option?
153  for (unsigned int i = 0; i < m; ++i)
154  result[i] = (*sys.C_eq)(i);
155 
156  // If gradient != nullptr, then the Jacobian matrix of the equality
157  // constraints has been requested. The incoming 'gradient'
158  // array is of length m*n and d(c_i)/d(x_j) = gradient[n*i+j].
159  if (gradient)
160  {
161  OptimizationSystem::ComputeEqualityConstraintsJacobian * eco_jac =
162  solver->equality_constraints_jacobian_object;
163 
164  if (eco_jac)
165  {
166  eco_jac->equality_constraints_jacobian(*sys.current_local_solution,
167  *sys.C_eq_jac,
168  sys);
169 
170  sys.C_eq_jac->close();
171 
172  // copy the Jacobian data to the gradient array
173  for (numeric_index_type i=0; i<m; i++)
174  for (const auto & dof_index : sys.eq_constraint_jac_sparsity[i])
175  gradient[n*i+dof_index] = (*sys.C_eq_jac)(i,dof_index);
176  }
177  else
178  libmesh_error_msg("Jacobian function not defined in __libmesh_nlopt_equality_constraints");
179  }
180 
181  }
182  else
183  libmesh_error_msg("Constraints function not defined in __libmesh_nlopt_equality_constraints");
184 }
IntRange< std::size_t > index_range(const std::vector< T > &vec)
Definition: int_range.h:104
dof_id_type numeric_index_type
Definition: id_types.h:92
IterBase * data

◆ __libmesh_nlopt_inequality_constraints()

void libMesh::__libmesh_nlopt_inequality_constraints ( unsigned  m,
double *  result,
unsigned  n,
const double *  x,
double *  gradient,
void *  data 
)

Definition at line 187 of file nlopt_optimization_solver.C.

References data, index_range(), libMesh::OptimizationSystem::ComputeInequalityConstraints::inequality_constraints(), libMesh::OptimizationSystem::ComputeInequalityConstraintsJacobian::inequality_constraints_jacobian(), libMesh::OptimizationSolver< T >::inequality_constraints_jacobian_object, libMesh::OptimizationSolver< T >::inequality_constraints_object, and libMesh::OptimizationSolver< T >::system().

Referenced by libMesh::NloptOptimizationSolver< T >::solve().

193 {
194  LOG_SCOPE("inequality_constraints()", "NloptOptimizationSolver");
195 
196  libmesh_assert(data);
197 
198  // data should be a pointer to the solver (it was passed in as void *)
199  NloptOptimizationSolver<Number> * solver =
200  static_cast<NloptOptimizationSolver<Number> *> (data);
201 
202  OptimizationSystem & sys = solver->system();
203 
204  // We'll use current_local_solution below, so let's ensure that it's consistent
205  // with the vector x that was passed in.
206  if (sys.solution->size() != n)
207  libmesh_error_msg("Error: Input vector x has different length than sys.solution!");
208 
209  for (auto i : index_range(*sys.solution))
210  sys.solution->set(i, x[i]);
211  sys.solution->close();
212 
213  // Impose constraints on the solution vector
214  sys.get_dof_map().enforce_constraints_exactly(sys);
215 
216  // Update sys.current_local_solution based on the solution vector
217  sys.update();
218 
219  // Call the user's inequality constraints function if there is one.
220  OptimizationSystem::ComputeInequalityConstraints * ineco = solver->inequality_constraints_object;
221  if (ineco)
222  {
223  ineco->inequality_constraints(*sys.current_local_solution,
224  *sys.C_ineq,
225  sys);
226 
227  sys.C_ineq->close();
228 
229  // Copy the values out of ineq_constraints into 'result'.
230  // TODO: Even better would be if we could use 'result' directly
231  // as the storage of ineq_constraints. Perhaps a serial-only
232  // NumericVector variant which supports this option?
233  for (unsigned int i = 0; i < m; ++i)
234  result[i] = (*sys.C_ineq)(i);
235 
236  // If gradient != nullptr, then the Jacobian matrix of the equality
237  // constraints has been requested. The incoming 'gradient'
238  // array is of length m*n and d(c_i)/d(x_j) = gradient[n*i+j].
239  if (gradient)
240  {
241  OptimizationSystem::ComputeInequalityConstraintsJacobian * ineco_jac =
242  solver->inequality_constraints_jacobian_object;
243 
244  if (ineco_jac)
245  {
246  ineco_jac->inequality_constraints_jacobian(*sys.current_local_solution,
247  *sys.C_ineq_jac,
248  sys);
249 
250  sys.C_ineq_jac->close();
251 
252  // copy the Jacobian data to the gradient array
253  for (numeric_index_type i=0; i<m; i++)
254  for (const auto & dof_index : sys.ineq_constraint_jac_sparsity[i])
255  gradient[n*i+dof_index] = (*sys.C_ineq_jac)(i,dof_index);
256  }
257  else
258  libmesh_error_msg("Jacobian function not defined in __libmesh_nlopt_inequality_constraints");
259  }
260 
261  }
262  else
263  libmesh_error_msg("Constraints function not defined in __libmesh_nlopt_inequality_constraints");
264 }
IntRange< std::size_t > index_range(const std::vector< T > &vec)
Definition: int_range.h:104
dof_id_type numeric_index_type
Definition: id_types.h:92
IterBase * data

◆ __libmesh_nlopt_objective()

double libMesh::__libmesh_nlopt_objective ( unsigned  n,
const double *  x,
double *  gradient,
void *  data 
)

Definition at line 37 of file nlopt_optimization_solver.C.

References data, libMesh::NloptOptimizationSolver< T >::get_iteration_count(), libMesh::OptimizationSystem::ComputeGradient::gradient(), libMesh::OptimizationSolver< T >::gradient_object, index_range(), libMesh::OptimizationSystem::ComputeObjective::objective(), libMesh::OptimizationSolver< T >::objective_object, out, Real, libMesh::OptimizationSolver< T >::system(), and libMesh::OptimizationSolver< T >::verbose.

Referenced by libMesh::NloptOptimizationSolver< T >::solve().

41 {
42  LOG_SCOPE("objective()", "NloptOptimizationSolver");
43 
44  // ctx should be a pointer to the solver (it was passed in as void *)
45  NloptOptimizationSolver<Number> * solver =
46  static_cast<NloptOptimizationSolver<Number> *> (data);
47 
48  OptimizationSystem & sys = solver->system();
49 
50  // We'll use current_local_solution below, so let's ensure that it's consistent
51  // with the vector x that was passed in.
52  for (auto i : index_range(*sys.solution))
53  sys.solution->set(i, x[i]);
54 
55  // Make sure the solution vector is parallel-consistent
56  sys.solution->close();
57 
58  // Impose constraints on X
59  sys.get_dof_map().enforce_constraints_exactly(sys);
60 
61  // Update sys.current_local_solution based on X
62  sys.update();
63 
64  Real objective;
65  if (solver->objective_object != nullptr)
66  {
67  objective =
68  solver->objective_object->objective(*(sys.current_local_solution), sys);
69  }
70  else
71  {
72  libmesh_error_msg("Objective function not defined in __libmesh_nlopt_objective");
73  }
74 
75  // If the gradient has been requested, fill it in
76  if (gradient)
77  {
78  if (solver->gradient_object != nullptr)
79  {
80  solver->gradient_object->gradient(*(sys.current_local_solution), *(sys.rhs), sys);
81 
82  // we've filled up sys.rhs with the gradient data, now copy it
83  // to the nlopt data structure
84  libmesh_assert(sys.rhs->size() == n);
85 
86  std::vector<double> grad;
87  sys.rhs->localize_to_one(grad);
88  for (unsigned int i = 0; i < n; ++i)
89  gradient[i] = grad[i];
90  }
91  else
92  libmesh_error_msg("Gradient function not defined in __libmesh_nlopt_objective");
93  }
94 
95  // Increment the iteration count.
96  solver->get_iteration_count()++;
97 
98  // Possibly print the current value of the objective function
99  if (solver->verbose)
100  libMesh::out << objective << std::endl;
101 
102  return objective;
103 }
IntRange< std::size_t > index_range(const std::vector< T > &vec)
Definition: int_range.h:104
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
IterBase * data
OStreamProxy out(std::cout)

◆ __libmesh_petsc_diff_solver_jacobian()

PetscErrorCode libMesh::__libmesh_petsc_diff_solver_jacobian ( SNES  ,
Vec  x,
#if   PETSC_RELEASE_LESS_THAN3, 5, 0) Mat *libmesh_dbg_var(j,
Mat *  pc,
MatStructure *  msflag,
#else Mat   libmesh_dbg_varj,
Mat  pc,
#endif void *  ctx 
)

Definition at line 132 of file petsc_diff_solver.C.

References libMesh::ImplicitSystem::assembly(), libMesh::ParallelObject::comm(), libMesh::System::current_local_solution, libMesh::DofMap::enforce_constraints_exactly(), libMesh::System::get_dof_map(), libMesh::ImplicitSystem::matrix, out, libMesh::System::solution, libMesh::PetscMatrix< T >::swap(), libMesh::DiffSolver::system(), libMesh::System::update(), and libMesh::DiffSolver::verbose.

Referenced by libMesh::PetscDiffSolver::solve().

143  {
144  libmesh_assert(x);
145  libmesh_assert(j);
146  // libmesh_assert_equal_to (pc, j); // We don't use separate preconditioners yet
147  libmesh_assert(ctx);
148 
149  PetscDiffSolver & solver =
150  *(static_cast<PetscDiffSolver*> (ctx));
151  ImplicitSystem & sys = solver.system();
152 
153  if (solver.verbose)
154  libMesh::out << "Assembling the Jacobian" << std::endl;
155 
156  PetscVector<Number> & X_system =
157  *cast_ptr<PetscVector<Number> *>(sys.solution.get());
158  PetscVector<Number> X_input(x, sys.comm());
159 
160 #if PETSC_RELEASE_LESS_THAN(3,5,0)
161  PetscMatrix<Number> J_input(*pc, sys.comm());
162 #else
163  PetscMatrix<Number> J_input(pc, sys.comm());
164 #endif
165  PetscMatrix<Number> & J_system =
166  *cast_ptr<PetscMatrix<Number> *>(sys.matrix);
167 
168  // DiffSystem assembles from the solution and into the jacobian, so
169  // swap those with our input vectors before assembling. They'll
170  // probably already be references to the same vectors, but PETSc
171  // might do something tricky.
172  X_input.swap(X_system);
173  J_input.swap(J_system);
174 
175  // We may need to localize a parallel solution
176  sys.update();
177 
178  // We may need to correct a non-conforming solution
179  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
180 
181  // Do DiffSystem assembly
182  sys.assembly(false, true);
183  J_system.close();
184 
185  // Swap back
186  X_input.swap(X_system);
187  J_input.swap(J_system);
188 
189 #if PETSC_RELEASE_LESS_THAN(3,5,0)
190  *msflag = SAME_NONZERO_PATTERN;
191 #endif
192  // No errors, we hope
193  return 0;
194  }
OStreamProxy out(std::cout)

◆ __libmesh_petsc_diff_solver_monitor()

PetscErrorCode libMesh::__libmesh_petsc_diff_solver_monitor ( SNES  snes,
PetscInt  its,
PetscReal  fnorm,
void *  ctx 
)

Definition at line 43 of file petsc_diff_solver.C.

References libMesh::PetscVector< T >::close(), libMesh::ParallelObject::comm(), libMesh::Parallel::Communicator::get(), ierr, libMesh::DiffSolver::linear_solution_monitor, out, and libMesh::DiffSolver::verbose.

Referenced by libMesh::PetscDiffSolver::setup_petsc_data().

47  {
48  PetscDiffSolver & solver =
49  *(static_cast<PetscDiffSolver *> (ctx));
50 
51  if (solver.verbose)
52  libMesh::out << " PetscDiffSolver step " << its
53  << ", |residual|_2 = " << fnorm << std::endl;
54  if (solver.linear_solution_monitor.get()) {
55  int ierr = 0;
56 
57  Vec petsc_delta_u;
58  ierr = SNESGetSolutionUpdate(snes, &petsc_delta_u);
59  CHKERRABORT(solver.comm().get(), ierr);
60  PetscVector<Number> delta_u(petsc_delta_u, solver.comm());
61  delta_u.close();
62 
63  Vec petsc_u;
64  ierr = SNESGetSolution(snes, &petsc_u);
65  CHKERRABORT(solver.comm().get(), ierr);
66  PetscVector<Number> u(petsc_u, solver.comm());
67  u.close();
68 
69  Vec petsc_res;
70  ierr = SNESGetFunction(snes, &petsc_res, nullptr, nullptr);
71  CHKERRABORT(solver.comm().get(), ierr);
72  PetscVector<Number> res(petsc_res, solver.comm());
73  res.close();
74 
75  (*solver.linear_solution_monitor)(
76  delta_u, delta_u.l2_norm(),
77  u, u.l2_norm(),
78  res, res.l2_norm(), its);
79  }
80  return 0;
81  }
PetscErrorCode ierr
OStreamProxy out(std::cout)

◆ __libmesh_petsc_diff_solver_residual()

PetscErrorCode libMesh::__libmesh_petsc_diff_solver_residual ( SNES  ,
Vec  x,
Vec  r,
void *  ctx 
)

Definition at line 86 of file petsc_diff_solver.C.

References libMesh::ImplicitSystem::assembly(), libMesh::ParallelObject::comm(), libMesh::System::current_local_solution, libMesh::DofMap::enforce_constraints_exactly(), libMesh::System::get_dof_map(), out, libMesh::ExplicitSystem::rhs, libMesh::System::solution, libMesh::PetscVector< T >::swap(), libMesh::DiffSolver::system(), libMesh::System::update(), and libMesh::DiffSolver::verbose.

Referenced by libMesh::PetscDiffSolver::solve().

87  {
88  libmesh_assert(x);
89  libmesh_assert(r);
90  libmesh_assert(ctx);
91 
92  PetscDiffSolver & solver =
93  *(static_cast<PetscDiffSolver*> (ctx));
94  ImplicitSystem & sys = solver.system();
95 
96  if (solver.verbose)
97  libMesh::out << "Assembling the residual" << std::endl;
98 
99  PetscVector<Number> & X_system =
100  *cast_ptr<PetscVector<Number> *>(sys.solution.get());
101  PetscVector<Number> & R_system =
102  *cast_ptr<PetscVector<Number> *>(sys.rhs);
103  PetscVector<Number> X_input(x, sys.comm()), R_input(r, sys.comm());
104 
105  // DiffSystem assembles from the solution and into the rhs, so swap
106  // those with our input vectors before assembling. They'll probably
107  // already be references to the same vectors, but PETSc might do
108  // something tricky.
109  X_input.swap(X_system);
110  R_input.swap(R_system);
111 
112  // We may need to localize a parallel solution
113  sys.update();
114 
115  // We may need to correct a non-conforming solution
116  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
117 
118  // Do DiffSystem assembly
119  sys.assembly(true, false);
120  R_system.close();
121 
122  // Swap back
123  X_input.swap(X_system);
124  R_input.swap(R_system);
125 
126  // No errors, we hope
127  return 0;
128  }
OStreamProxy out(std::cout)

◆ __libmesh_petsc_preconditioner_apply() [1/2]

PetscErrorCode libMesh::__libmesh_petsc_preconditioner_apply ( void *  ctx,
Vec  x,
Vec  y 
)

This function is called by PETSc to actually apply the preconditioner. ctx will hold the Preconditioner.

Definition at line 110 of file petsc_linear_solver.C.

References libmesh_petsc_preconditioner_apply().

111  {
112  libmesh_deprecated();
113  return libmesh_petsc_preconditioner_apply(ctx, x, y);
114  }
PetscErrorCode libmesh_petsc_preconditioner_apply(PC pc, Vec x, Vec y)

◆ __libmesh_petsc_preconditioner_apply() [2/2]

PetscErrorCode libMesh::__libmesh_petsc_preconditioner_apply ( PC  pc,
Vec  x,
Vec  y 
)

Definition at line 123 of file petsc_linear_solver.C.

References libmesh_petsc_preconditioner_apply().

124  {
125  libmesh_deprecated();
126  return libmesh_petsc_preconditioner_apply(pc, x, y);
127  }
PetscErrorCode libmesh_petsc_preconditioner_apply(PC pc, Vec x, Vec y)

◆ __libmesh_petsc_preconditioner_setup() [1/2]

PetscErrorCode libMesh::__libmesh_petsc_preconditioner_setup ( void *  ctx)

This function is called by PETSc to initialize the preconditioner. ctx will hold the Preconditioner.

Definition at line 104 of file petsc_linear_solver.C.

References libmesh_petsc_preconditioner_setup().

105  {
106  libmesh_deprecated();
108  }
PetscErrorCode libmesh_petsc_preconditioner_setup(PC pc)

◆ __libmesh_petsc_preconditioner_setup() [2/2]

PetscErrorCode libMesh::__libmesh_petsc_preconditioner_setup ( PC  pc)

Definition at line 117 of file petsc_linear_solver.C.

References libmesh_petsc_preconditioner_setup().

118  {
119  libmesh_deprecated();
121  }
PetscErrorCode libmesh_petsc_preconditioner_setup(PC pc)

◆ __libmesh_petsc_snes_fd_residual()

PetscErrorCode libMesh::__libmesh_petsc_snes_fd_residual ( SNES  snes,
Vec  x,
Vec  r,
void *  ctx 
)

Definition at line 227 of file petsc_nonlinear_solver.C.

References libmesh_petsc_snes_fd_residual().

228  {
229  libmesh_deprecated();
230  return libmesh_petsc_snes_fd_residual(snes, x, r, ctx);
231  }
PetscErrorCode libmesh_petsc_snes_fd_residual(SNES snes, Vec x, Vec r, void *ctx)

◆ __libmesh_petsc_snes_jacobian() [1/3]

PetscErrorCode libMesh::__libmesh_petsc_snes_jacobian ( SNES  ,
Vec  x,
Mat *  jac,
Mat *  pc,
MatStructure *  msflag,
void *  ctx 
)

◆ __libmesh_petsc_snes_jacobian() [2/3]

PetscErrorCode libMesh::__libmesh_petsc_snes_jacobian ( SNES  ,
Vec  x,
Mat  jac,
Mat  pc,
void *  ctx 
)

◆ __libmesh_petsc_snes_jacobian() [3/3]

PetscErrorCode libMesh::__libmesh_petsc_snes_jacobian ( #if PETSC_RELEASE_LESS_THAN(3, 5, 0) SNES  snes,
Vec  x,
Mat *  jac,
Mat *  pc,
MatStructure *  msflag,
void *ctx #else SNES  snes,
Vec  x,
Mat  jac,
Mat  pc,
void *ctx #  endif 
)

Definition at line 396 of file petsc_nonlinear_solver.C.

References libmesh_petsc_snes_jacobian().

403  {
404  libmesh_deprecated();
406 #if PETSC_RELEASE_LESS_THAN(3,5,0)
407  snes, x, jac, pc, msflag, ctx
408 #else
409  snes, x, jac, pc, ctx
410 #endif
411  );
412  }
PetscErrorCode libmesh_petsc_snes_jacobian(#if PETSC_RELEASE_LESS_THAN(3, 5, 0) SNES snes, Vec x, Mat *jac, Mat *pc, MatStructure *msflag, void *ctx #else SNES snes, Vec x, Mat jac, Mat pc, void *ctx #endif)

◆ __libmesh_petsc_snes_mffd_interface()

PetscErrorCode libMesh::__libmesh_petsc_snes_mffd_interface ( void *  ctx,
Vec  x,
Vec  r 
)

Definition at line 278 of file petsc_nonlinear_solver.C.

References libmesh_petsc_snes_mffd_interface().

279  {
280  libmesh_deprecated();
281  return libmesh_petsc_snes_mffd_interface(ctx, x, r);
282  }
PetscErrorCode libmesh_petsc_snes_mffd_interface(void *ctx, Vec x, Vec r)

◆ __libmesh_petsc_snes_monitor()

PetscErrorCode libMesh::__libmesh_petsc_snes_monitor ( SNES  ,
PetscInt  its,
PetscReal  fnorm,
void *   
)

Definition at line 139 of file petsc_nonlinear_solver.C.

References libmesh_petsc_snes_monitor().

140  {
141  libmesh_deprecated();
142  return libmesh_petsc_snes_monitor(nullptr, its, fnorm, nullptr);
143  }
PetscErrorCode libmesh_petsc_snes_monitor(SNES, PetscInt its, PetscReal fnorm, void *)

◆ __libmesh_petsc_snes_postcheck()

PetscErrorCode libMesh::__libmesh_petsc_snes_postcheck ( #if PETSC_VERSION_LESS_THAN(3, 3, 0)  SNES,
Vec  x,
Vec  y,
Vec  w,
void *  context,
PetscBool changed_y,
PetscBool *changed_w #else  SNESLineSearch,
Vec  x,
Vec  y,
Vec  w,
PetscBool changed_y,
PetscBool changed_w,
void *context #  endif 
)

Definition at line 522 of file petsc_nonlinear_solver.C.

References libmesh_petsc_snes_postcheck().

529  {
530  libmesh_deprecated();
532 #if PETSC_VERSION_LESS_THAN(3,3,0)
533  nullptr, x, y, w, context, changed_y, changed_w
534 #else
535  nullptr, x, y, w, changed_y, changed_w, context
536 #endif
537  );
538  }
PetscErrorCode libmesh_petsc_snes_postcheck(#if PETSC_VERSION_LESS_THAN(3, 3, 0) SNES, Vec x, Vec y, Vec w, void *context, PetscBool *changed_y, PetscBool *changed_w #else SNESLineSearch, Vec x, Vec y, Vec w, PetscBool *changed_y, PetscBool *changed_w, void *context #endif)

◆ __libmesh_petsc_snes_residual()

PetscErrorCode libMesh::__libmesh_petsc_snes_residual ( SNES  snes,
Vec  x,
Vec  r,
void *  ctx 
)

Definition at line 191 of file petsc_nonlinear_solver.C.

References libmesh_petsc_snes_residual().

192  {
193  libmesh_deprecated();
194  return libmesh_petsc_snes_residual(snes, x, r, ctx);
195  }
PetscErrorCode libmesh_petsc_snes_residual(SNES snes, Vec x, Vec r, void *ctx)

◆ __libmesh_tao_equality_constraints()

PetscErrorCode libMesh::__libmesh_tao_equality_constraints ( Tao  ,
Vec  x,
Vec  ce,
void *  ctx 
)

Definition at line 205 of file tao_optimization_solver.C.

References libMesh::ParallelObject::comm(), libMesh::OptimizationSystem::ComputeEqualityConstraints::equality_constraints(), libMesh::OptimizationSolver< T >::equality_constraints_object, ierr, libMesh::PetscVector< T >::swap(), libMesh::OptimizationSolver< T >::system(), and libMesh::PetscVector< T >::zero().

Referenced by libMesh::TaoOptimizationSolver< T >::solve().

206  {
207  LOG_SCOPE("equality_constraints()", "TaoOptimizationSolver");
208 
209  PetscErrorCode ierr = 0;
210 
211  libmesh_assert(x);
212  libmesh_assert(ce);
213  libmesh_assert(ctx);
214 
215  // ctx should be a pointer to the solver (it was passed in as void *)
216  TaoOptimizationSolver<Number> * solver =
217  static_cast<TaoOptimizationSolver<Number> *> (ctx);
218 
219  OptimizationSystem & sys = solver->system();
220 
221  // We'll use current_local_solution below, so let's ensure that it's consistent
222  // with the vector x that was passed in.
223  PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
224  PetscVector<Number> X(x, sys.comm());
225 
226  // Perform a swap so that sys.solution points to the input vector
227  // "x", update sys.current_local_solution based on "x", then swap
228  // back.
229  X.swap(X_sys);
230  sys.update();
231  X.swap(X_sys);
232 
233  // We'll also pass the constraints vector ce into the assembly routine
234  // so let's make a PETSc vector for that too.
235  PetscVector<Number> eq_constraints(ce, sys.comm());
236 
237  // Clear the gradient prior to assembly
238  eq_constraints.zero();
239 
240  // Enforce constraints exactly on the current_local_solution.
241  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
242 
243  if (solver->equality_constraints_object != nullptr)
244  solver->equality_constraints_object->equality_constraints(*(sys.current_local_solution), eq_constraints, sys);
245  else
246  libmesh_error_msg("Constraints function not defined in __libmesh_tao_equality_constraints");
247 
248  eq_constraints.close();
249 
250  return ierr;
251  }
PetscErrorCode ierr

◆ __libmesh_tao_equality_constraints_jacobian()

PetscErrorCode libMesh::__libmesh_tao_equality_constraints_jacobian ( Tao  ,
Vec  x,
Mat  J,
Mat  Jpre,
void *  ctx 
)

Definition at line 257 of file tao_optimization_solver.C.

References libMesh::ParallelObject::comm(), libMesh::OptimizationSystem::ComputeEqualityConstraintsJacobian::equality_constraints_jacobian(), libMesh::OptimizationSolver< T >::equality_constraints_jacobian_object, ierr, libMesh::PetscVector< T >::swap(), and libMesh::OptimizationSolver< T >::system().

Referenced by libMesh::TaoOptimizationSolver< T >::solve().

258  {
259  LOG_SCOPE("equality_constraints_jacobian()", "TaoOptimizationSolver");
260 
261  PetscErrorCode ierr = 0;
262 
263  libmesh_assert(x);
264  libmesh_assert(J);
265  libmesh_assert(Jpre);
266 
267  // ctx should be a pointer to the solver (it was passed in as void *)
268  TaoOptimizationSolver<Number> * solver =
269  static_cast<TaoOptimizationSolver<Number> *> (ctx);
270 
271  OptimizationSystem & sys = solver->system();
272 
273  // We'll use current_local_solution below, so let's ensure that it's consistent
274  // with the vector x that was passed in.
275  PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
276  PetscVector<Number> X(x, sys.comm());
277 
278  // Perform a swap so that sys.solution points to the input vector
279  // "x", update sys.current_local_solution based on "x", then swap
280  // back.
281  X.swap(X_sys);
282  sys.update();
283  X.swap(X_sys);
284 
285  // Let's also wrap J and Jpre in PetscMatrix objects for convenience
286  PetscMatrix<Number> J_petsc(J, sys.comm());
287  PetscMatrix<Number> Jpre_petsc(Jpre, sys.comm());
288 
289  // Enforce constraints exactly on the current_local_solution.
290  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
291 
292  if (solver->equality_constraints_jacobian_object != nullptr)
293  solver->equality_constraints_jacobian_object->equality_constraints_jacobian(*(sys.current_local_solution), J_petsc, sys);
294  else
295  libmesh_error_msg("Constraints function not defined in __libmesh_tao_equality_constraints_jacobian");
296 
297  J_petsc.close();
298  Jpre_petsc.close();
299 
300  return ierr;
301  }
PetscErrorCode ierr

◆ __libmesh_tao_gradient()

PetscErrorCode libMesh::__libmesh_tao_gradient ( Tao  ,
Vec  x,
Vec  g,
void *  ctx 
)

Definition at line 97 of file tao_optimization_solver.C.

References libMesh::ParallelObject::comm(), libMesh::OptimizationSystem::ComputeGradient::gradient(), libMesh::OptimizationSolver< T >::gradient_object, ierr, libMesh::PetscVector< T >::swap(), libMesh::OptimizationSolver< T >::system(), and libMesh::PetscVector< T >::zero().

Referenced by libMesh::TaoOptimizationSolver< T >::solve().

98  {
99  LOG_SCOPE("gradient()", "TaoOptimizationSolver");
100 
101  PetscErrorCode ierr = 0;
102 
103  libmesh_assert(x);
104  libmesh_assert(g);
105  libmesh_assert(ctx);
106 
107  // ctx should be a pointer to the solver (it was passed in as void *)
108  TaoOptimizationSolver<Number> * solver =
109  static_cast<TaoOptimizationSolver<Number> *> (ctx);
110 
111  OptimizationSystem & sys = solver->system();
112 
113  // We'll use current_local_solution below, so let's ensure that it's consistent
114  // with the vector x that was passed in.
115  PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
116  PetscVector<Number> X(x, sys.comm());
117 
118  // Perform a swap so that sys.solution points to the input vector
119  // "x", update sys.current_local_solution based on "x", then swap
120  // back.
121  X.swap(X_sys);
122  sys.update();
123  X.swap(X_sys);
124 
125  // We'll also pass the gradient in to the assembly routine
126  // so let's make a PETSc vector for that too.
127  PetscVector<Number> gradient(g, sys.comm());
128 
129  // Clear the gradient prior to assembly
130  gradient.zero();
131 
132  // Enforce constraints exactly on the current_local_solution.
133  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
134 
135  if (solver->gradient_object != nullptr)
136  solver->gradient_object->gradient(*(sys.current_local_solution), gradient, sys);
137  else
138  libmesh_error_msg("Gradient function not defined in __libmesh_tao_gradient");
139 
140  gradient.close();
141 
142  return ierr;
143  }
PetscErrorCode ierr

◆ __libmesh_tao_hessian()

PetscErrorCode libMesh::__libmesh_tao_hessian ( Tao  ,
Vec  x,
Mat  h,
Mat  pc,
void *  ctx 
)

Definition at line 148 of file tao_optimization_solver.C.

References libMesh::SparseMatrix< T >::attach_dof_map(), libMesh::ParallelObject::comm(), libMesh::OptimizationSystem::ComputeHessian::hessian(), libMesh::OptimizationSolver< T >::hessian_object, ierr, libMesh::PetscVector< T >::swap(), and libMesh::OptimizationSolver< T >::system().

Referenced by libMesh::TaoOptimizationSolver< T >::solve().

149  {
150  LOG_SCOPE("hessian()", "TaoOptimizationSolver");
151 
152  PetscErrorCode ierr = 0;
153 
154  libmesh_assert(x);
155  libmesh_assert(h);
156  libmesh_assert(pc);
157  libmesh_assert(ctx);
158 
159  // ctx should be a pointer to the solver (it was passed in as void *)
160  TaoOptimizationSolver<Number> * solver =
161  static_cast<TaoOptimizationSolver<Number> *> (ctx);
162 
163  OptimizationSystem & sys = solver->system();
164 
165  // We'll use current_local_solution below, so let's ensure that it's consistent
166  // with the vector x that was passed in.
167  PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
168  PetscVector<Number> X(x, sys.comm());
169 
170  // Perform a swap so that sys.solution points to the input vector
171  // "x", update sys.current_local_solution based on "x", then swap
172  // back.
173  X.swap(X_sys);
174  sys.update();
175  X.swap(X_sys);
176 
177  // Let's also wrap pc and h in PetscMatrix objects for convenience
178  PetscMatrix<Number> PC(pc, sys.comm());
179  PetscMatrix<Number> hessian(h, sys.comm());
180  PC.attach_dof_map(sys.get_dof_map());
181  hessian.attach_dof_map(sys.get_dof_map());
182 
183  // Enforce constraints exactly on the current_local_solution.
184  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
185 
186  if (solver->hessian_object != nullptr)
187  {
188  // Following PetscNonlinearSolver by passing in PC. It's not clear
189  // why we pass in PC and not hessian though?
190  solver->hessian_object->hessian(*(sys.current_local_solution), PC, sys);
191  }
192  else
193  libmesh_error_msg("Hessian function not defined in __libmesh_tao_hessian");
194 
195  PC.close();
196  hessian.close();
197 
198  return ierr;
199  }
PetscErrorCode ierr

◆ __libmesh_tao_inequality_constraints()

PetscErrorCode libMesh::__libmesh_tao_inequality_constraints ( Tao  ,
Vec  x,
Vec  cineq,
void *  ctx 
)

Definition at line 306 of file tao_optimization_solver.C.

References libMesh::ParallelObject::comm(), ierr, libMesh::OptimizationSystem::ComputeInequalityConstraints::inequality_constraints(), libMesh::OptimizationSolver< T >::inequality_constraints_object, libMesh::PetscVector< T >::swap(), libMesh::OptimizationSolver< T >::system(), and libMesh::PetscVector< T >::zero().

Referenced by libMesh::TaoOptimizationSolver< T >::solve().

307  {
308  LOG_SCOPE("inequality_constraints()", "TaoOptimizationSolver");
309 
310  PetscErrorCode ierr = 0;
311 
312  libmesh_assert(x);
313  libmesh_assert(cineq);
314  libmesh_assert(ctx);
315 
316  // ctx should be a pointer to the solver (it was passed in as void *)
317  TaoOptimizationSolver<Number> * solver =
318  static_cast<TaoOptimizationSolver<Number> *> (ctx);
319 
320  OptimizationSystem & sys = solver->system();
321 
322  // We'll use current_local_solution below, so let's ensure that it's consistent
323  // with the vector x that was passed in.
324  PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
325  PetscVector<Number> X(x, sys.comm());
326 
327  // Perform a swap so that sys.solution points to the input vector
328  // "x", update sys.current_local_solution based on "x", then swap
329  // back.
330  X.swap(X_sys);
331  sys.update();
332  X.swap(X_sys);
333 
334  // We'll also pass the constraints vector ce into the assembly routine
335  // so let's make a PETSc vector for that too.
336  PetscVector<Number> ineq_constraints(cineq, sys.comm());
337 
338  // Clear the gradient prior to assembly
339  ineq_constraints.zero();
340 
341  // Enforce constraints exactly on the current_local_solution.
342  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
343 
344  if (solver->inequality_constraints_object != nullptr)
345  solver->inequality_constraints_object->inequality_constraints(*(sys.current_local_solution), ineq_constraints, sys);
346  else
347  libmesh_error_msg("Constraints function not defined in __libmesh_tao_inequality_constraints");
348 
349  ineq_constraints.close();
350 
351  return ierr;
352  }
PetscErrorCode ierr

◆ __libmesh_tao_inequality_constraints_jacobian()

PetscErrorCode libMesh::__libmesh_tao_inequality_constraints_jacobian ( Tao  ,
Vec  x,
Mat  J,
Mat  Jpre,
void *  ctx 
)

Definition at line 358 of file tao_optimization_solver.C.

References libMesh::ParallelObject::comm(), ierr, libMesh::OptimizationSystem::ComputeInequalityConstraintsJacobian::inequality_constraints_jacobian(), libMesh::OptimizationSolver< T >::inequality_constraints_jacobian_object, libMesh::PetscVector< T >::swap(), and libMesh::OptimizationSolver< T >::system().

Referenced by libMesh::TaoOptimizationSolver< T >::solve().

359  {
360  LOG_SCOPE("inequality_constraints_jacobian()", "TaoOptimizationSolver");
361 
362  PetscErrorCode ierr = 0;
363 
364  libmesh_assert(x);
365  libmesh_assert(J);
366  libmesh_assert(Jpre);
367 
368  // ctx should be a pointer to the solver (it was passed in as void *)
369  TaoOptimizationSolver<Number> * solver =
370  static_cast<TaoOptimizationSolver<Number> *> (ctx);
371 
372  OptimizationSystem & sys = solver->system();
373 
374  // We'll use current_local_solution below, so let's ensure that it's consistent
375  // with the vector x that was passed in.
376  PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
377  PetscVector<Number> X(x, sys.comm());
378 
379  // Perform a swap so that sys.solution points to the input vector
380  // "x", update sys.current_local_solution based on "x", then swap
381  // back.
382  X.swap(X_sys);
383  sys.update();
384  X.swap(X_sys);
385 
386  // Let's also wrap J and Jpre in PetscMatrix objects for convenience
387  PetscMatrix<Number> J_petsc(J, sys.comm());
388  PetscMatrix<Number> Jpre_petsc(Jpre, sys.comm());
389 
390  // Enforce constraints exactly on the current_local_solution.
391  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
392 
393  if (solver->inequality_constraints_jacobian_object != nullptr)
394  solver->inequality_constraints_jacobian_object->inequality_constraints_jacobian(*(sys.current_local_solution), J_petsc, sys);
395  else
396  libmesh_error_msg("Constraints function not defined in __libmesh_tao_inequality_constraints_jacobian");
397 
398  J_petsc.close();
399  Jpre_petsc.close();
400 
401  return ierr;
402  }
PetscErrorCode ierr

◆ __libmesh_tao_objective()

PetscErrorCode libMesh::__libmesh_tao_objective ( Tao  ,
Vec  x,
PetscReal *  objective,
void *  ctx 
)

Definition at line 49 of file tao_optimization_solver.C.

References libMesh::ParallelObject::comm(), ierr, libMesh::OptimizationSystem::ComputeObjective::objective(), libMesh::OptimizationSolver< T >::objective_object, libMesh::PetscVector< T >::swap(), and libMesh::OptimizationSolver< T >::system().

Referenced by libMesh::TaoOptimizationSolver< T >::solve().

50  {
51  LOG_SCOPE("objective()", "TaoOptimizationSolver");
52 
53  PetscErrorCode ierr = 0;
54 
55  libmesh_assert(x);
56  libmesh_assert(objective);
57  libmesh_assert(ctx);
58 
59  // ctx should be a pointer to the solver (it was passed in as void *)
60  TaoOptimizationSolver<Number> * solver =
61  static_cast<TaoOptimizationSolver<Number> *> (ctx);
62 
63  OptimizationSystem & sys = solver->system();
64 
65  // We'll use current_local_solution below, so let's ensure that it's consistent
66  // with the vector x that was passed in.
67  PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
68  PetscVector<Number> X(x, sys.comm());
69 
70  // Perform a swap so that sys.solution points to the input vector
71  // "x", update sys.current_local_solution based on "x", then swap
72  // back.
73  X.swap(X_sys);
74  sys.update();
75  X.swap(X_sys);
76 
77  // Enforce constraints (if any) exactly on the
78  // current_local_solution. This is the solution vector that is
79  // actually used in the computation of the objective function
80  // below, and is not locked by debug-enabled PETSc the way that
81  // the solution vector is.
82  sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
83 
84  if (solver->objective_object != nullptr)
85  (*objective) = solver->objective_object->objective(*(sys.current_local_solution), sys);
86  else
87  libmesh_error_msg("Objective function not defined in __libmesh_tao_objective");
88 
89  return ierr;
90  }
PetscErrorCode ierr

◆ as_range() [1/2]

template<typename I >
SimpleRange<I> libMesh::as_range ( const std::pair< I, I > &  p)

Helper function that allows us to treat a homogenous pair as a range. Useful for writing range-based for loops over the pair returned by std::equal_range() and std::map::equal_range().

Definition at line 57 of file simple_range.h.

Referenced by libMesh::Partitioner::_find_global_index_by_pid_map(), libMesh::BoundaryInfo::_find_id_maps(), libMesh::MeshRefinement::_refine_elements(), libMesh::BoundaryInfo::add_edge(), libMesh::BoundaryInfo::add_elements(), libMesh::BoundaryInfo::add_node(), libMesh::BoundaryInfo::add_shellface(), libMesh::BoundaryInfo::add_side(), libMesh::DofMap::allgather_recursive_constraints(), libMesh::AbaqusIO::assign_sideset_ids(), libMesh::BoundaryInfo::boundary_ids(), libMesh::Partitioner::build_graph(), libMesh::BoundaryInfo::build_side_list_from_node_list(), libMesh::Singleton::cleanup(), libMesh::CentroidPartitioner::compute_centroids(), connect_children(), libMesh::UnstructuredMesh::contract(), libMesh::UnstructuredMesh::create_submesh(), libMesh::MeshCommunication::delete_remote_elements(), DMCreateFieldDecomposition_libMesh(), libMesh::BoundaryInfo::edge_boundary_ids(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::LocationMap< T >::find(), libMesh::UnstructuredMesh::find_neighbors(), libMesh::UNVIO::groups_in(), libMesh::BoundaryInfo::has_boundary_id(), libMesh::MeshTools::libmesh_assert_parallel_consistent_procids< Node >(), libMesh::MeshTools::libmesh_assert_topology_consistent_procids< Node >(), libMesh::MeshTools::libmesh_assert_valid_remote_elems(), libMesh::MeshRefinement::make_coarsening_compatible(), libMesh::DofMap::merge_ghost_functor_outputs(), libMesh::MeshTools::n_active_levels(), libMesh::CheckpointIO::n_active_levels_in(), libMesh::MeshTools::n_levels(), libMesh::MeshTools::n_local_levels(), libMesh::MeshTools::n_non_subactive_elem_of_type_at_level(), libMesh::MeshTools::n_p_levels(), libMesh::GhostPointNeighbors::operator()(), libMesh::SiblingCoupling::operator()(), libMesh::DefaultCoupling::operator()(), libMesh::PointNeighborCoupling::operator()(), libMesh::MetisPartitioner::partition_range(), libMesh::LinearPartitioner::partition_range(), libMesh::MappedSubdomainPartitioner::partition_range(), libMesh::SFCPartitioner::partition_range(), libMesh::Partitioner::partition_unpartitioned_elements(), query_ghosting_functors(), libMesh::BoundaryInfo::raw_boundary_ids(), libMesh::BoundaryInfo::raw_edge_boundary_ids(), libMesh::BoundaryInfo::raw_shellface_boundary_ids(), libMesh::GmshIO::read_mesh(), libMesh::XdrIO::read_serialized_bcs_helper(), libMesh::XdrIO::read_serialized_nodesets(), libMesh::ReplicatedMesh::renumber_nodes_and_elements(), libMesh::DofMap::scatter_constraints(), libMesh::Partitioner::set_node_processor_ids(), libMesh::Partitioner::set_parent_processor_ids(), libMesh::BoundaryInfo::shellface_boundary_ids(), libMesh::BoundaryInfo::side_with_boundary_id(), libMesh::Partitioner::single_partition_range(), libMesh::MeshTools::Modification::smooth(), libMesh::Parallel::sync_node_data_by_element_id_once(), libMesh::MeshRefinement::uniformly_coarsen(), libMesh::TecplotIO::write_binary(), libMesh::XdrIO::write_serialized_bcs_helper(), and libMesh::XdrIO::write_serialized_connectivity().

58 {
59  return {p.first, p.second};
60 }

◆ as_range() [2/2]

template<typename I >
SimpleRange<I> libMesh::as_range ( const I &  first,
const I &  second 
)

As above, but can be used in cases where a std::pair is not otherwise involved.

Definition at line 69 of file simple_range.h.

71 {
72  return {first, second};
73 }

◆ cast_int()

template<typename Tnew , typename Told >
Tnew libMesh::cast_int ( Told  oldvar)
inline

Definition at line 545 of file libmesh_common.h.

546 {
547  libmesh_assert_equal_to
548  (oldvar, static_cast<Told>(static_cast<Tnew>(oldvar)));
549 
550  return(static_cast<Tnew>(oldvar));
551 }

◆ cast_ptr()

template<typename Tnew , typename Told >
Tnew libMesh::cast_ptr ( Told *  oldvar)
inline

Definition at line 508 of file libmesh_common.h.

References err, and libMesh::Quality::name().

Referenced by libMesh::Parameters::have_parameter().

509 {
510 #if !defined(NDEBUG) && defined(LIBMESH_HAVE_RTTI)
511  Tnew newvar = dynamic_cast<Tnew>(oldvar);
512  if (!newvar)
513  {
514  libMesh::err << "Failed to convert " << typeid(Told).name()
515  << " pointer to " << typeid(Tnew).name()
516  << std::endl;
517  libMesh::err << "The " << typeid(Told).name()
518  << " appears to be a "
519  << typeid(*oldvar).name() << std::endl;
520  libmesh_error();
521  }
522  return newvar;
523 #else
524  return(static_cast<Tnew>(oldvar));
525 #endif
526 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42
OStreamProxy err(std::cerr)

◆ cast_ref()

template<typename Tnew , typename Told >
Tnew libMesh::cast_ref ( Told &  oldvar)
inline

Definition at line 472 of file libmesh_common.h.

References err, and libMesh::Quality::name().

473 {
474 #if !defined(NDEBUG) && defined(LIBMESH_HAVE_RTTI) && defined(LIBMESH_ENABLE_EXCEPTIONS)
475  try
476  {
477  Tnew newvar = dynamic_cast<Tnew>(oldvar);
478  return newvar;
479  }
480  catch (std::bad_cast &)
481  {
482  libMesh::err << "Failed to convert " << typeid(Told).name()
483  << " reference to " << typeid(Tnew).name()
484  << std::endl;
485  libMesh::err << "The " << typeid(Told).name()
486  << " appears to be a "
487  << typeid(*(&oldvar)).name() << std::endl;
488  libmesh_error();
489  }
490 #else
491  return(static_cast<Tnew>(oldvar));
492 #endif
493 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42
OStreamProxy err(std::cerr)

◆ closed()

bool libMesh::closed ( )

Checks that the library has been closed. This should always return false when called from a library object. It is useful to libmesh_assert(!libMeshclosed()) in library object destructors.

Definition at line 265 of file libmesh.C.

References libMesh::libMeshPrivateData::_is_initialized.

Referenced by libMesh::PetscMatrix< T >::_get_submatrix(), libMesh::EigenSparseVector< T >::l1_norm(), libMesh::LaspackVector< T >::l1_norm(), libMesh::EpetraVector< T >::l1_norm(), libMesh::PetscVector< T >::l1_norm(), libMesh::PetscMatrix< T >::l1_norm(), libMesh::EigenSparseVector< T >::l2_norm(), libMesh::LaspackVector< T >::l2_norm(), libMesh::EpetraVector< T >::l2_norm(), libMesh::PetscVector< T >::l2_norm(), libMesh::LibMeshInit::LibMeshInit(), libMesh::EigenSparseVector< T >::linfty_norm(), libMesh::LaspackVector< T >::linfty_norm(), libMesh::EpetraVector< T >::linfty_norm(), libMesh::PetscVector< T >::linfty_norm(), libMesh::PetscMatrix< T >::linfty_norm(), libMesh::PetscMatrix< T >::operator()(), libMesh::DistributedVector< T >::operator+=(), libMesh::EigenSparseVector< T >::operator+=(), libMesh::LaspackVector< T >::operator+=(), libMesh::EpetraVector< T >::operator+=(), libMesh::PetscVector< T >::operator+=(), libMesh::DistributedVector< T >::operator-=(), libMesh::EigenSparseVector< T >::operator-=(), libMesh::LaspackVector< T >::operator-=(), libMesh::EpetraVector< T >::operator-=(), libMesh::PetscVector< T >::operator-=(), libMesh::EigenSparseVector< T >::operator/=(), libMesh::EpetraVector< T >::operator/=(), libMesh::EigenSparseVector< T >::operator=(), libMesh::LaspackVector< T >::operator=(), libMesh::PetscVector< T >::operator=(), libMesh::PetscMatrix< T >::print_matlab(), libMesh::PetscVector< T >::print_matlab(), libMesh::PetscMatrix< T >::print_personal(), libMesh::EigenSparseVector< T >::sum(), libMesh::LaspackVector< T >::sum(), libMesh::EpetraVector< T >::sum(), libMesh::PetscVector< T >::sum(), libMesh::EigenSparseVector< T >::zero(), libMesh::LaspackVector< T >::zero(), libMesh::EpetraVector< T >::zero(), libMesh::PetscVector< T >::zero(), libMesh::MeshBase::~MeshBase(), libMesh::System::~System(), and libMesh::UnstructuredMesh::~UnstructuredMesh().

266 {
268 }

◆ command_line_next()

template<typename T >
T libMesh::command_line_next ( std::string  name,
default_value 
)

Use GetPot's search()/next() functions to get following arguments from the command line.

For backwards compatibility with past option naming conventions, libMesh searches for the given argument first in its original form, then with all underscores changed to dashes, then with all dashes (except any leading dashes) changed to underscores, and returns true if any of the above finds a match.

This routine manipulates the command_line cursor and should not be called concurrently with similar utilities in multiple threads.

Definition at line 941 of file libmesh.C.

References libMesh::Quality::name(), on_command_line(), and value.

Referenced by libMesh::NloptOptimizationSolver< T >::init(), and libMesh::DofMap::use_coupled_neighbor_dofs().

942 {
943  // on_command_line also puts the command_line cursor in the spot we
944  // need
945  if (on_command_line(name))
946  return command_line->next(value);
947 
948  return value;
949 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42
static const bool value
Definition: xdr_io.C:109
bool on_command_line(std::string arg)
Definition: libmesh.C:876

◆ command_line_next< double >()

template double libMesh::command_line_next< double > ( std::string  ,
double   
)

◆ command_line_next< float >()

template float libMesh::command_line_next< float > ( std::string  ,
float   
)

◆ command_line_next< int >()

template int libMesh::command_line_next< int > ( std::string  ,
int   
)

◆ command_line_next< long double >()

template long double libMesh::command_line_next< long double > ( std::string  ,
long  double 
)

◆ command_line_next< short >()

template short libMesh::command_line_next< short > ( std::string  ,
short   
)

◆ command_line_next< std::string >()

template std::string libMesh::command_line_next< std::string > ( std::string  ,
std::string   
)

◆ command_line_next< unsigned int >()

template unsigned int libMesh::command_line_next< unsigned int > ( std::string  ,
unsigned  int 
)

◆ command_line_next< unsigned short >()

template unsigned short libMesh::command_line_next< unsigned short > ( std::string  ,
unsigned  short 
)

◆ command_line_value() [1/2]

template<typename T >
T libMesh::command_line_value ( const std::string &  ,
 
)
Returns
The value associated with name on the command line if it is specified, otherwise return the default, provided value. A second template function is provided to support recognizing multiple variations of a given option

This routine manipulates the command_line cursor and should not be called concurrently with similar utilities in multiple threads.

Definition at line 909 of file libmesh.C.

References libMesh::Quality::name(), and value.

Referenced by libMesh::LibMeshInit::LibMeshInit(), and petsc_auto_fieldsplit().

910 {
911  // Make sure the command line parser is ready for use
912  libmesh_assert(command_line.get());
913 
914  // only if the variable exists in the file
915  if (command_line->have_variable(name.c_str()))
916  value = (*command_line)(name.c_str(), value);
917 
918  return value;
919 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42
static const bool value
Definition: xdr_io.C:109

◆ command_line_value() [2/2]

template<typename T >
T libMesh::command_line_value ( const std::vector< std::string > &  name,
value 
)

Definition at line 922 of file libmesh.C.

References libMesh::Quality::name(), and value.

923 {
924  // Make sure the command line parser is ready for use
925  libmesh_assert(command_line.get());
926 
927  // Check for multiple options (return the first that matches)
928  for (const auto & entry : name)
929  if (command_line->have_variable(entry.c_str()))
930  {
931  value = (*command_line)(entry.c_str(), value);
932  break;
933  }
934 
935  return value;
936 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42
static const bool value
Definition: xdr_io.C:109

◆ command_line_value< double >() [1/2]

template double libMesh::command_line_value< double > ( const std::string &  ,
double   
)

◆ command_line_value< double >() [2/2]

template double libMesh::command_line_value< double > ( const std::vector< std::string > &  ,
double   
)

◆ command_line_value< float >() [1/2]

template float libMesh::command_line_value< float > ( const std::string &  ,
float   
)

◆ command_line_value< float >() [2/2]

template float libMesh::command_line_value< float > ( const std::vector< std::string > &  ,
float   
)

◆ command_line_value< int >() [1/2]

template int libMesh::command_line_value< int > ( const std::string &  ,
int   
)

◆ command_line_value< int >() [2/2]

template int libMesh::command_line_value< int > ( const std::vector< std::string > &  ,
int   
)

◆ command_line_value< long double >() [1/2]

template long double libMesh::command_line_value< long double > ( const std::string &  ,
long  double 
)

◆ command_line_value< long double >() [2/2]

template long double libMesh::command_line_value< long double > ( const std::vector< std::string > &  ,
long  double 
)

◆ command_line_value< short >() [1/2]

template short libMesh::command_line_value< short > ( const std::string &  ,
short   
)

◆ command_line_value< short >() [2/2]

template short libMesh::command_line_value< short > ( const std::vector< std::string > &  ,
short   
)

◆ command_line_value< std::string >() [1/2]

template std::string libMesh::command_line_value< std::string > ( const std::string &  ,
std::string   
)

◆ command_line_value< std::string >() [2/2]

template std::string libMesh::command_line_value< std::string > ( const std::vector< std::string > &  ,
std::string   
)

◆ command_line_value< unsigned int >() [1/2]

template unsigned int libMesh::command_line_value< unsigned int > ( const std::string &  ,
unsigned  int 
)

◆ command_line_value< unsigned int >() [2/2]

template unsigned int libMesh::command_line_value< unsigned int > ( const std::vector< std::string > &  ,
unsigned  int 
)

◆ command_line_value< unsigned short >() [1/2]

template unsigned short libMesh::command_line_value< unsigned short > ( const std::string &  ,
unsigned  short 
)

◆ command_line_value< unsigned short >() [2/2]

template unsigned short libMesh::command_line_value< unsigned short > ( const std::vector< std::string > &  ,
unsigned  short 
)

◆ command_line_vector()

template<typename T >
void libMesh::command_line_vector ( const std::string &  ,
std::vector< T > &   
)
Returns
The array of values associated with name on the command line if it is specified, otherwise return the default, provided array.

This routine manipulates the command_line cursor and should not be called concurrently with similar utilities in multiple threads.

Definition at line 954 of file libmesh.C.

References libMesh::Quality::name().

955 {
956  // Make sure the command line parser is ready for use
957  libmesh_assert(command_line.get());
958 
959  // only if the variable exists on the command line
960  if (command_line->have_variable(name.c_str()))
961  {
962  unsigned size = command_line->vector_variable_size(name.c_str());
963  vec.resize(size);
964 
965  for (unsigned i=0; i<size; ++i)
966  vec[i] = (*command_line)(name.c_str(), vec[i], i);
967  }
968 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42

◆ command_line_vector< double >()

template void libMesh::command_line_vector< double > ( const std::string &  ,
std::vector< double > &   
)

◆ command_line_vector< float >()

template void libMesh::command_line_vector< float > ( const std::string &  ,
std::vector< float > &   
)

◆ command_line_vector< int >()

template void libMesh::command_line_vector< int > ( const std::string &  ,
std::vector< int > &   
)

◆ command_line_vector< long double >()

template void libMesh::command_line_vector< long double > ( const std::string &  ,
std::vector< long double > &   
)

◆ command_line_vector< short >()

template void libMesh::command_line_vector< short > ( const std::string &  ,
std::vector< short > &   
)

◆ command_line_vector< unsigned int >()

template void libMesh::command_line_vector< unsigned int > ( const std::string &  ,
std::vector< unsigned int > &   
)

◆ command_line_vector< unsigned short >()

template void libMesh::command_line_vector< unsigned short > ( const std::string &  ,
std::vector< unsigned short > &   
)

◆ connect_children()

void libMesh::connect_children ( const MeshBase mesh,
MeshBase::const_element_iterator  elem_it,
MeshBase::const_element_iterator  elem_end,
std::set< const Elem *, CompareElemIdsByLevel > &  connected_elements 
)

Definition at line 168 of file mesh_communication.C.

References as_range(), libMesh::Elem::child_ref_range(), libMesh::Elem::has_children(), libmesh_ignore(), mesh, and remote_elem.

Referenced by libMesh::MeshCommunication::delete_remote_elements(), and libMesh::CheckpointIO::write().

172 {
173  // None of these parameters are used when !LIBMESH_ENABLE_AMR.
174  libmesh_ignore(mesh, elem_it, elem_end, connected_elements);
175 
176 #ifdef LIBMESH_ENABLE_AMR
177  // Our XdrIO output needs inactive local elements to not have any
178  // remote_elem children. Let's make sure that doesn't happen.
179  //
180  for (const auto & elem : as_range(elem_it, elem_end))
181  {
182  if (elem->has_children())
183  for (auto & child : elem->child_ref_range())
184  if (&child != remote_elem)
185  connected_elements.insert(&child);
186  }
187 #endif // LIBMESH_ENABLE_AMR
188 }
MeshBase & mesh
void libmesh_ignore(const Args &...)
SimpleRange< I > as_range(const std::pair< I, I > &p)
Definition: simple_range.h:57
const RemoteElem * remote_elem
Definition: remote_elem.C:57

◆ connect_families()

void libMesh::connect_families ( std::set< const Elem *, CompareElemIdsByLevel > &  connected_elements)

Definition at line 191 of file mesh_communication.C.

References libMesh::Elem::active(), libMesh::Elem::has_children(), libmesh_ignore(), libMesh::Elem::parent(), remote_elem, and libMesh::Elem::total_family_tree().

Referenced by libMesh::MeshCommunication::delete_remote_elements(), and libMesh::CheckpointIO::write().

192 {
193  // This parameter is not used when !LIBMESH_ENABLE_AMR.
194  libmesh_ignore(connected_elements);
195 
196 #ifdef LIBMESH_ENABLE_AMR
197 
198  // Because our set is sorted by ascending level, we can traverse it
199  // in reverse order, adding parents as we go, and end up with all
200  // ancestors added. This is safe for std::set where insert doesn't
201  // invalidate iterators.
202  //
203  // This only works because we do *not* cache
204  // connected_elements.rend(), whose value can change when we insert
205  // elements which are sorted before the original rend.
206  //
207  // We're also going to get subactive descendents here, when any
208  // exist. We're iterating in the wrong direction to do that
209  // non-recursively, so we'll cop out and rely on total_family_tree.
210  // Iterating backwards does mean that we won't be querying the newly
211  // inserted subactive elements redundantly.
212 
213  std::set<const Elem *, CompareElemIdsByLevel>::reverse_iterator
214  elem_rit = connected_elements.rbegin();
215 
216  for (; elem_rit != connected_elements.rend(); ++elem_rit)
217  {
218  const Elem * elem = *elem_rit;
219  libmesh_assert(elem);
220  const Elem * parent = elem->parent();
221 
222  // We let ghosting functors worry about only active elements,
223  // but the remote processor needs all its semilocal elements'
224  // ancestors and active semilocal elements' descendants too.
225  if (parent)
226  connected_elements.insert (parent);
227 
228  if (elem->active() && elem->has_children())
229  {
230  std::vector<const Elem *> subactive_family;
231  elem->total_family_tree(subactive_family);
232  for (std::size_t i=0; i != subactive_family.size(); ++i)
233  {
234  libmesh_assert(subactive_family[i] != remote_elem);
235  connected_elements.insert(subactive_family[i]);
236  }
237  }
238  }
239 
240 # ifdef DEBUG
241  // Let's be paranoid and make sure that all our ancestors
242  // really did get inserted. I screwed this up the first time
243  // by caching rend, and I can easily imagine screwing it up in
244  // the future by changing containers.
245  for (const auto & elem : connected_elements)
246  {
247  libmesh_assert(elem);
248  const Elem * parent = elem->parent();
249  if (parent)
250  libmesh_assert(connected_elements.count(parent));
251  }
252 # endif // DEBUG
253 
254 #endif // LIBMESH_ENABLE_AMR
255 }
const Elem * parent() const
Definition: elem.h:2479
The base class for all geometric element types.
Definition: elem.h:100
void total_family_tree(std::vector< const Elem *> &active_family, const bool reset=true) const
Definition: elem.C:1557
void libmesh_ignore(const Args &...)
bool active() const
Definition: elem.h:2390
bool has_children() const
Definition: elem.h:2428
const RemoteElem * remote_elem
Definition: remote_elem.C:57

◆ convert_solve_result()

DiffSolver::SolveResult libMesh::convert_solve_result ( SNESConvergedReason  r)

Definition at line 251 of file petsc_diff_solver.C.

References libMesh::DiffSolver::CONVERGED_ABSOLUTE_RESIDUAL, libMesh::DiffSolver::CONVERGED_NO_REASON, libMesh::DiffSolver::CONVERGED_RELATIVE_RESIDUAL, libMesh::DiffSolver::CONVERGED_RELATIVE_STEP, libMesh::DiffSolver::DIVERGED_BACKTRACKING_FAILURE, libMesh::DiffSolver::DIVERGED_MAX_NONLINEAR_ITERATIONS, libMesh::DiffSolver::DIVERGED_NO_REASON, and libMesh::DiffSolver::INVALID_SOLVE_RESULT.

Referenced by libMesh::PetscDiffSolver::solve().

252 {
253  switch (r)
254  {
255  case SNES_CONVERGED_FNORM_ABS:
256  return DiffSolver::CONVERGED_ABSOLUTE_RESIDUAL;
257  case SNES_CONVERGED_FNORM_RELATIVE:
258  return DiffSolver::CONVERGED_RELATIVE_RESIDUAL;
259 #if PETSC_VERSION_LESS_THAN(3,2,1)
260  case SNES_CONVERGED_PNORM_RELATIVE:
261 #else
262  case SNES_CONVERGED_SNORM_RELATIVE:
263 #endif
264  return DiffSolver::CONVERGED_RELATIVE_STEP;
265  case SNES_CONVERGED_ITS:
266  case SNES_CONVERGED_TR_DELTA:
267  return DiffSolver::CONVERGED_NO_REASON;
268  case SNES_DIVERGED_FUNCTION_DOMAIN:
269  case SNES_DIVERGED_FUNCTION_COUNT:
270  case SNES_DIVERGED_FNORM_NAN:
271 #if !PETSC_VERSION_LESS_THAN(3,3,0)
272  case SNES_DIVERGED_INNER:
273 #endif
274  case SNES_DIVERGED_LINEAR_SOLVE:
275  case SNES_DIVERGED_LOCAL_MIN:
276  return DiffSolver::DIVERGED_NO_REASON;
277  case SNES_DIVERGED_MAX_IT:
278  return DiffSolver::DIVERGED_MAX_NONLINEAR_ITERATIONS;
279 #if PETSC_VERSION_LESS_THAN(3,2,0)
280  case SNES_DIVERGED_LS_FAILURE:
281 #else
282  case SNES_DIVERGED_LINE_SEARCH:
283 #endif
284  return DiffSolver::DIVERGED_BACKTRACKING_FAILURE;
285  // In PETSc, SNES_CONVERGED_ITERATING means
286  // the solve is still iterating, but by the
287  // time we get here, we must have either
288  // converged or diverged, so
289  // SNES_CONVERGED_ITERATING is invalid.
290  case SNES_CONVERGED_ITERATING:
291  return DiffSolver::INVALID_SOLVE_RESULT;
292  default:
293  break;
294  }
295  return DiffSolver::INVALID_SOLVE_RESULT;
296 }

◆ cross_norm()

template<typename T >
T libMesh::cross_norm ( const TypeVector< T > &  b,
const TypeVector< T > &  c 
)
inline

Calls cross_norm_sq() and takes the square root of the result.

Definition at line 1097 of file type_vector.h.

References cross_norm_sq().

Referenced by libMesh::Quad4::volume(), libMesh::Tri3::volume(), libMesh::Quad8::volume(), libMesh::Tri6::volume(), and libMesh::Quad9::volume().

1099 {
1100  return std::sqrt(cross_norm_sq(b,c));
1101 }
T cross_norm_sq(const TypeVector< T > &b, const TypeVector< T > &c)
Definition: type_vector.h:1076

◆ cross_norm_sq()

template<typename T >
T libMesh::cross_norm_sq ( const TypeVector< T > &  b,
const TypeVector< T > &  c 
)
inline

Compute |b x c|^2 without creating the extra temporary produced by calling b.cross(c).norm_sq().

Definition at line 1076 of file type_vector.h.

Referenced by cross_norm().

1078 {
1079  T z = b(0)*c(1) - b(1)*c(0);
1080 
1081 #if LIBMESH_DIM == 3
1082  T x = b(1)*c(2) - b(2)*c(1),
1083  y = b(0)*c(2) - b(2)*c(0);
1084  return x*x + y*y + z*z;
1085 #else
1086  return z*z;
1087 #endif
1088 }

◆ default_solver_package()

SolverPackage libMesh::default_solver_package ( )
Returns
The default solver interface to use. The value depends on which solver packages were available when the library was configured. The command-line is also checked, allowing the user to override the compiled default. For example, –use-petsc will force the use of PETSc solvers, and –use-laspack will force the use of LASPACK solvers.

Definition at line 971 of file libmesh.C.

References libMesh::libMeshPrivateData::_solver_package, EIGEN_SOLVERS, initialized(), INVALID_SOLVER_PACKAGE, LASPACK_SOLVERS, on_command_line(), PETSC_SOLVERS, and TRILINOS_SOLVERS.

972 {
973  libmesh_assert (libMesh::initialized());
974 
975  static bool called = false;
976 
977  // Check the command line. Since the command line is
978  // unchanging it is sufficient to do this only once.
979  if (!called)
980  {
981  called = true;
982 
983 #ifdef LIBMESH_HAVE_PETSC