dirichlet_boundaries.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 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_DIRICHLET_BOUNDARIES_H
#define LIBMESH_DIRICHLET_BOUNDARIES_H

#include "libmesh/libmesh_config.h"

#ifdef LIBMESH_ENABLE_DIRICHLET

// Local Includes
#include "libmesh/id_types.h"
#include "libmesh/vector_value.h"

// C++ Includes
#include <cstddef>
#include <set>
#include <vector>
#include <memory>

namespace libMesh
{

// Forward declarations
class System;

template <typename Output> class FEMFunctionBase;
template <typename Output> class FunctionBase;

enum VariableIndexing { SYSTEM_VARIABLE_ORDER = 0,
                        LOCAL_VARIABLE_ORDER };

class DirichletBoundary
{
public:

  DirichletBoundary(std::set<boundary_id_type> b_in,
                    std::vector<unsigned int> variables_in,
                    const FunctionBase<Number> * f_in,
                    const FunctionBase<Gradient> * g_in = nullptr);

  DirichletBoundary(std::set<boundary_id_type> b_in,
                    std::vector<unsigned int> variables_in,
                    const FunctionBase<Number> & f_in,
                    VariableIndexing type = SYSTEM_VARIABLE_ORDER);

  DirichletBoundary(std::set<boundary_id_type> b_in,
                    std::vector<unsigned int> variables_in,
                    const FunctionBase<Number> & f_in,
                    const FunctionBase<Gradient> & g_in,
                    VariableIndexing type = SYSTEM_VARIABLE_ORDER);

  DirichletBoundary(std::set<boundary_id_type> b_in,
                    std::vector<unsigned int> variables_in,
                    const System & f_sys_in,
                    const FEMFunctionBase<Number> * f_in,
                    const FEMFunctionBase<Gradient> * g_in = nullptr);

  DirichletBoundary(std::set<boundary_id_type> b_in,
                    std::vector<unsigned int> variables_in,
                    const System & f_sys_in,
                    const FEMFunctionBase<Number> & f_in,
                    VariableIndexing type = SYSTEM_VARIABLE_ORDER);

  DirichletBoundary(std::set<boundary_id_type> b_in,
                    std::vector<unsigned int> variables_in,
                    const System & f_sys_in,
                    const FEMFunctionBase<Number> & f_in,
                    const FEMFunctionBase<Gradient> & g_in,
                    VariableIndexing type = SYSTEM_VARIABLE_ORDER);

  DirichletBoundary (const DirichletBoundary & dirichlet_in);
  DirichletBoundary & operator= (const DirichletBoundary &);

  DirichletBoundary (DirichletBoundary &&) = default;
  DirichletBoundary & operator= (DirichletBoundary &&) = default;

  ~DirichletBoundary ();

  std::set<boundary_id_type> b;
  std::vector<unsigned int> variables;

  std::unique_ptr<FunctionBase<Number>> f;
  std::unique_ptr<FunctionBase<Gradient>> g;

  std::unique_ptr<FEMFunctionBase<Number>> f_fem;
  std::unique_ptr<FEMFunctionBase<Gradient>> g_fem;

  const System * f_system;

  Real jacobian_tolerance;
};


class DirichletBoundaries : public std::vector<std::unique_ptr<DirichletBoundary>>
{
public:
  DirichletBoundaries() = default;
  ~DirichletBoundaries() = default;
};

} // namespace libMesh

#endif // LIBMESH_ENABLE_DIRICHLET

#endif // LIBMESH_DIRICHLET_BOUNDARIES_H