DOLFINx
DOLFINx C++ interface
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 ▼Ndolfinx
 ▼NcommonMiscellaneous classes, functions and types
 CIndexMapThis class represents the distribution index arrays across processes. An index array is a contiguous collection of N+1 indices [0, 1, . . ., N] that are distributed across M processes. On a given process, the IndexMap stores a portion of the index set using local indices [0, 1, . . . , n], and a map from the local indices to a unique global index
 CTimeLoggerTimer logging
 CTimeLogManagerLogger initialisation
 CTimerA timer can be used for timing tasks. The basic usage is
 CUniqueIdGeneratorThis is a singleton class that return IDs that are unique in the lifetime of a program
 ▼NfemFinite element method functionality
 CDirichletBCInterface for setting (strong) Dirichlet boundary conditions
 CFormClass for variational forms
 CConstantA constant value which can be attached to a Form. Constants may be scalar (rank 0), vector (rank 1), or tensor valued
 CCoordinateElementThis class manages coordinate mappings for isoparametric cells
 CDofMapDegree-of-freedom map
 CElementDofLayoutThe class represents the degree-of-freedom (dofs) for an element. Dofs are associated with a mesh entity. This class also handles sub-space dofs, which are views into the parent dofs
 CExpressionRepresents a mathematical expression evaluated at a pre-defined set of points on the reference cell. This class closely follows the concept of a UFC Expression
 CFiniteElementFinite Element, containing the dof layout on a reference element, and various methods for evaluating and transforming the basis
 CFunctionThis class represents a function \( u_h \) in a finite element function space \( V_h \), given by
 CFunctionSpaceThis class represents a finite element function space defined by a mesh, a finite element, and a local-to-global map of the degrees of freedom (dofmap)
 ▼Nfunction
 CFunction
 ▼NgeometryGeometry data structures and algorithms
 CBoundingBoxTreeAxis-Aligned bounding box binary tree. It is used to find entities in a collection (often a mesh::Mesh)
 ▼NgraphGraph data structures and algorithms
 CAdjacencyListThis class provides a static adjacency list data structure. It is commonly used to store directed graphs. For each node in the contiguous list of nodes [0, 1, 2, ..., n) it stores the connected nodes. The representation is strictly local, i.e. it is not parallel aware
 ▼NioSupport for file IO
 CHDF5InterfaceThis class provides an interface to some HDF5 functionality
 CVTKFileOutput of meshes and functions in VTK/ParaView format. Isoparametric meshes of arbitrary degree are supported. For finite element functions, cell-based (DG0) and Lagrange (point-based) functions can be saved. For vertex-based functions the output must be isoparametic, i.e. the geometry and the finite element functions must be defined using the same basis
 CXDMFFileRead and write mesh::Mesh, fem::Function and other objects in XDMF
 ▼NlaLinear algebra interface
 CPETScKrylovSolverThis class implements Krylov methods for linear systems of the form Ax = b. It is a wrapper for the Krylov solvers of PETSc
 CPETScMatrixIt is a simple wrapper for a PETSc matrix pointer (Mat). Its main purpose is to assist memory management of PETSc Mat objects
 CPETScOperatorThis class is a base class for matrices that can be used in PETScKrylovSolver
 CPETScOptionsThese class provides static functions that permit users to set and retrieve PETSc options via the PETSc option/parameter system. The option must not be prefixed by '-', e.g
 CPETScVectorA simple wrapper for a PETSc vector pointer (Vec). Its main purpose is to assist with memory/lifetime management of PETSc Vec objects
 CSparsityPatternThis class provides a sparsity pattern data structure that can be used to initialize sparse matrices
 CVectorDistributed vector
 CVectorSpaceBasisThis class defines a basis for vector spaces, typically used for expressing nullspaces of singular operators and 'near nullspaces' used in smoothed aggregation algebraic multigrid
 ▼NmeshMesh data structures and algorithms on meshes
 CMeshTagsA MeshTags are used to associate mesh entities with values. The entity index (local to process) identifies the entity. MeshTags is a sparse data storage class; it allows tags to be associated with an arbitrary subset of mesh entities. An entity can have only one associated tag
 CGeometryGeometry stores the geometry imposed on a mesh
 CMeshA Mesh consists of a set of connected and numbered mesh topological entities, and geometry data
 CTopologyTopology stores the topology of a mesh, consisting of mesh entities and connectivity (incidence relations for the mesh entities)
 ▼NMPIMPI support functionality
 CCommA duplicate MPI communicator and manage lifetime of the communicator
 Cdependent_false
 ▼NnlsNonlinear solvers
 CNewtonSolverThis class defines a Newton solver for nonlinear systems of equations of the form \(F(x) = 0\)
 Carray2dThis class provides a dynamic 2-dimensional row-wise array data structure
 CTableThis class provides storage and pretty-printing for tables. Example usage: