GlobalParameters.h

// Copyright (C) 2009-2011 Anders Logg
//
// This file is part of DOLFIN.
//
// DOLFIN 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN 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 DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Fredrik Valdmanis, 2011
//
// First added:  2009-07-02
// Last changed: 2013-06-21

#ifndef __GLOBAL_PARAMETERS_H
#define __GLOBAL_PARAMETERS_H

#include "Parameters.h"
#include <dolfin/la/KrylovSolver.h>
#include <dolfin/la/LUSolver.h>

namespace dolfin
{


  class GlobalParameters : public Parameters
  {
  public:

    GlobalParameters();

    virtual ~GlobalParameters();

    virtual void parse(int argc, char* argv[]);

    static Parameters default_parameters()
    {
      Parameters p("dolfin");

      //-- General

      // Prefix for timer tasks
      p.add("timer_prefix", "");

      // Allow extrapolation in function interpolation
      p.add("allow_extrapolation", false);

      //-- Input

      // Warn if reading large XML files in parallel (MB)
      p.add("warn_on_xml_file_size", 100);

      //-- Output

      // Print standard output on all processes
      p.add("std_out_all_processes", true);

      // Line width relative to edge length in SVG output
      p.add("relative_line_width", 0.025);

      // Print the level of thread support provided by the MPI library
      p.add("print_mpi_thread_support_level", false);

      //-- dof ordering

      // DOF reordering when running in serial
      p.add("reorder_dofs_serial", true);

      // Add dof ordering library
      std::string default_dof_ordering_library = "Boost";
      #ifdef HAS_SCOTCH
      default_dof_ordering_library = "SCOTCH";
      #endif
      p.add("dof_ordering_library", default_dof_ordering_library,
            {"Boost", "random", "SCOTCH"});

      //-- Meshes

      // Mesh ghosting type
      p.add("ghost_mode", "none",
            {"shared_facet", "shared_vertex", "none"});

      // Mesh ordering via SCOTCH and GPS
      p.add("reorder_cells_gps", false);
      p.add("reorder_vertices_gps", false);

      // Set default graph/mesh partitioner
      std::string default_mesh_partitioner = "SCOTCH";
      #ifdef HAS_PARMETIS
        #ifndef HAS_SCOTCH
        default_mesh_partitioner = "ParMETIS";
        #endif
      #endif
      p.add("mesh_partitioner", default_mesh_partitioner,
            {"ParMETIS", "SCOTCH", "None"});

      // Approaches to partitioning (following Zoltan syntax)
      // but applies to ParMETIS
      p.add("partitioning_approach", "PARTITION",
            {"PARTITION", "REPARTITION", "REFINE"});

      #ifdef HAS_PARMETIS
      // Repartitioning parameter, determines how strongly to hold on
      // to cells when shifting between processes
      p.add("ParMETIS_repartitioning_weight", 1000.0);
      #endif

      // Mesh refinement
      p.add("refinement_algorithm", "plaza",
            {"regular_cut", "plaza", "plaza_with_parent_facets"});

      //-- Graphs

      // Graph coloring
      std::set<std::string> allowed_coloring_libraries;
      allowed_coloring_libraries.insert("Boost");
      #ifdef HAS_TRILINOS
      allowed_coloring_libraries.insert("Zoltan");
      #endif
      p.add("graph_coloring_library", "Boost", allowed_coloring_libraries);

      //-- Linear algebra

      // Linear algebra backend
      std::string default_backend = "Eigen";
      std::set<std::string> allowed_backends = {"Eigen"};
      #ifdef HAS_PETSC
      allowed_backends.insert("PETSc");
      default_backend = "PETSc";
      p.add("use_petsc_signal_handler", false);
      #endif
      #ifdef HAS_TRILINOS
      allowed_backends.insert("Tpetra");
        #ifndef HAS_PETSC
        default_backend = "Tpetra";
        #endif
      #endif

      p.add("linear_algebra_backend",
            default_backend,
            allowed_backends);

      // Add nested parameter sets
      p.add(KrylovSolver::default_parameters());
      p.add(LUSolver::default_parameters());

      return p;
    }

  };

  extern GlobalParameters parameters;

}

#endif