DOLFIN-X
DOLFIN-X C++ interface
Namespaces | Classes | Enumerations | Functions
dolfinx Namespace Reference

Low-level methods for reading XDMF files. More...

Namespaces

 common
 Miscellaneous classes, functions and types.
 
 fem
 Finite element method functionality.
 
 function
 Functions tools, including FEM functions and pointwise defined functions.
 
 generation
 Generators for simple meshes.
 
 geometry
 Geometry data structures and algorithms.
 
 graph
 Graph data structures and algorithms.
 
 io
 Support for file IO.
 
 la
 Linear algebra interface.
 
 mesh
 Mesh data structures.
 
 nls
 Nonlinear solvers.
 
 refinement
 Mesh refinement algorithms.
 

Classes

class  MPI
 This class provides utility functions for easy communication with MPI and handles cases when DOLFINX is not configured with MPI. More...
 
class  Table
 This class provides storage and pretty-printing for tables. Example usage: More...
 

Enumerations

enum  TimingType : std::int32_t { wall = 0, user = 1, system = 2 }
 Timing types: More...
 

Functions

std::string version ()
 Return DOLFINX version string.
 
std::string ufc_signature ()
 Return UFC signature string.
 
std::string git_commit_hash ()
 Return git changeset hash (returns "unknown" if changeset is not known)
 
bool has_debug ()
 Return true if DOLFINX is compiled in debugging mode, i.e., with assertions on.
 
bool has_petsc_complex ()
 Return true if DOLFINX is configured with PETSc compiled with scalars represented as complex numbers.
 
bool has_slepc ()
 Return true if DOLFINX is compiled with SLEPc.
 
bool has_scotch ()
 Return true if DOLFINX is compiled with Scotch.
 
bool has_parmetis ()
 Return true if DOLFINX is compiled with ParMETIS.
 
bool has_kahip ()
 Return true if DOLFINX is compiled with KaHIP.
 
void init (int argc, char *argv[])
 Initialize DOLFINX (and PETSc) with command-line arguments. This should not be needed in most cases since the initialization is otherwise handled automatically.
 
Table timings (std::set< TimingType > type)
 Return a summary of timings and tasks in a Table. More...
 
void list_timings (MPI_Comm mpi_comm, std::set< TimingType > type)
 List a summary of timings and tasks. MPI_AVG reduction is printed. More...
 
std::tuple< std::size_t, double, double, double > timing (std::string task)
 Return timing (count, total wall time, total user time, total system time) for given task. More...
 

Detailed Description

Low-level methods for reading XDMF files.

Enumeration Type Documentation

◆ TimingType

enum dolfinx::TimingType : std::int32_t
strong

Timing types:

  • TimingType::wall wall-clock time
  • TimingType::user user (cpu) time
  • TimingType::system system (kernel) time

Function Documentation

◆ list_timings()

void dolfinx::list_timings ( MPI_Comm  mpi_comm,
std::set< TimingType type 
)

List a summary of timings and tasks. MPI_AVG reduction is printed.

Parameters
[in]mpi_commMPI Communicator
[in]typeSubset of { TimingType::wall, TimingType::user, TimingType::system }

◆ timing()

std::tuple< std::size_t, double, double, double > dolfinx::timing ( std::string  task)

Return timing (count, total wall time, total user time, total system time) for given task.

Parameters
[in]taskName of a task
Returns
The (count, total wall time, total user time, total system time) for the task

◆ timings()

Table dolfinx::timings ( std::set< TimingType type)

Return a summary of timings and tasks in a Table.

Parameters
[in]typesubset of { TimingType::wall, TimingType::user, TimingType::system }
Returns
Table with timings