libmesh.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef LIBMESH_LIBMESH_H
#define LIBMESH_LIBMESH_H
 
 
// Local includes
#include "libmesh/libmesh_base.h"
#include "libmesh/libmesh_common.h"
#include "libmesh/libmesh_config.h"
 
// C++ includes
#include <string>
#include <vector>
 
// Forward declarations
// For dealing with MPI stuff in VTK.
#if defined(LIBMESH_HAVE_MPI) && defined(LIBMESH_HAVE_VTK)
class vtkMPIController;
#endif
 
namespace TIMPI {
  class TIMPIInit;
}
 
#ifdef GETPOT_NAMESPACE
namespace GETPOT_NAMESPACE {
#endif
class GetPot;
#ifdef GETPOT_NAMESPACE
}
#endif
 
namespace libMesh
{
 
// Forward declarations
namespace Parallel {
  class Communicator;
}
 
class PerfLog;
enum SolverPackage : int;
 
class LibMeshInit
{
public:
#ifdef LIBMESH_HAVE_MPI
  LibMeshInit(int argc, const char * const * argv,
              MPI_Comm COMM_WORLD_IN=MPI_COMM_WORLD, int n_threads=-1);
#else
  LibMeshInit(int argc, const char * const * argv,
              int COMM_WORLD_IN=0, int n_threads=-1);
#endif
 
  virtual ~LibMeshInit();
 
  const Parallel::Communicator & comm() const { return *_comm; }
 
  Parallel::Communicator & comm() { return *_comm; }
 
private:
  // Should we just bite the bullet, use unique_ptr here, and bring an
  // #include <memory> into everything?
  TIMPI::TIMPIInit * _timpi_init;
 
  // Or should we keep this around so we can still inline its
  // accessors despite forward declaring _timpi_init?
  //
  // This is constructed from the TIMPI::Communicator, for backwards
  // compatibility.
  Parallel::Communicator * _comm;
 
#if defined(LIBMESH_HAVE_MPI) && defined(LIBMESH_HAVE_VTK)
  // VTK object for dealing with MPI stuff in VTK.
  // This can't be a std::unique_ptr because VTK makes the destructor
  // protected and forces us to use a named destructor manually
  vtkMPIController * _vtk_mpi_controller;
#endif
 
#ifdef LIBMESH_ENABLE_EXCEPTIONS
  static std::terminate_handler _old_terminate_handler;
#endif
 
  static PerfLog & perf_log();
 
  friend void libmesh_abort();
  friend void libmesh_terminate_handler();
};
 
bool initialized ();
 
bool closed ();
 
bool on_command_line (std::string arg);
 
template <typename T>
T command_line_value (const std::string &, T);
template <typename T>
T command_line_value (const std::vector<std::string> &, T);
 
template <typename T>
T command_line_next (std::string name, T default_value);
 
template <typename T>
void command_line_vector (const std::string &, std::vector<T> &);
 
std::vector<std::string> command_line_names();
 
void add_command_line_name(const std::string & name);
 
void add_command_line_names(const GetPot & getpot);
 
 
#ifdef LIBMESH_USE_COMPLEX_NUMBERS
extern const Number imaginary;
#endif
 
SolverPackage default_solver_package ();
 
#ifdef LIBMESH_DEFAULT_QUADRUPLE_PRECISION
constexpr Real operator ""_R(const char * r) { return Real(r); }
#else
constexpr Real operator ""_R(long double r) { return r; }
constexpr Real operator ""_R(unsigned long long r) { return Real(r); }
#endif
 
const Real pi = 3.1415926535897932384626433832795029_R;
 
const Number zero = 0.;
 
const unsigned int invalid_uint = static_cast<unsigned int>(-1);
 
const int invalid_int = std::numeric_limits<int>::max();
 
} // namespace libMesh
 
#endif // LIBMESH_LIBMESH_H