finite_element_state.hpp

Go to the documentation of this file.

// Copyright (c) 2019-2024, Lawrence Livermore National Security, LLC and
// other Serac Project Developers. See the top-level LICENSE file for
// details.
//
// SPDX-License-Identifier: (BSD-3-Clause)
 
#pragma once
 
#include <functional>
#include <memory>
#include <optional>
 
#include "mfem.hpp"
 
#include "serac/infrastructure/variant.hpp"
#include "serac/physics/state/finite_element_vector.hpp"
 
namespace serac {
 
inline bool is_scalar_valued(const GeneralCoefficient& coef)
{
  return holds_alternative<std::shared_ptr<mfem::Coefficient>>(coef);
}
 
inline bool is_vector_valued(const GeneralCoefficient& coef)
{
  return holds_alternative<std::shared_ptr<mfem::VectorCoefficient>>(coef);
}
 
class FiniteElementState : public FiniteElementVector {
public:
  using FiniteElementVector::FiniteElementVector;
  using mfem::Vector::Print;
 
  FiniteElementState(const FiniteElementState& rhs) : FiniteElementVector(rhs) {}
 
  FiniteElementState(FiniteElementState&& rhs) : FiniteElementVector(std::move(rhs)) {}
 
  FiniteElementState& operator=(const FiniteElementState& rhs)
  {
    FiniteElementVector::operator=(rhs);
    return *this;
  }
 
  FiniteElementState& operator=(FiniteElementState&& rhs)
  {
    FiniteElementVector::operator=(rhs);
    return *this;
  }
 
  FiniteElementState& operator=(const mfem::HypreParVector& rhs)
  {
    FiniteElementVector::operator=(rhs);
    return *this;
  }
 
  FiniteElementState& operator=(const mfem::Vector& rhs)
  {
    FiniteElementVector::operator=(rhs);
    return *this;
  }
 
  FiniteElementState& operator=(double rhs)
  {
    FiniteElementVector::operator=(rhs);
    return *this;
  }
 
  void fillGridFunction(mfem::ParGridFunction& grid_function) const { grid_function.SetFromTrueDofs(*this); }
 
  void setFromGridFunction(const mfem::ParGridFunction& grid_function) { grid_function.GetTrueDofs(*this); }
 
  void project(mfem::VectorCoefficient& coef, mfem::Array<int>& dof_list);
 
  void project(mfem::Coefficient& coef, mfem::Array<int>& dof_list, std::optional<int> component = {});
 
  void project(const GeneralCoefficient& coef);
 
  void project(mfem::Coefficient& coef);
 
  void project(mfem::VectorCoefficient& coef);
 
  void projectOnBoundary(mfem::Coefficient& coef, const mfem::Array<int>& markers);
 
  void projectOnBoundary(mfem::VectorCoefficient& coef, const mfem::Array<int>& markers);
 
  mfem::ParGridFunction& gridFunction() const;
 
protected:
  mutable std::unique_ptr<mfem::ParGridFunction> grid_func_;
};
 
double norm(const FiniteElementState& state, const double p = 2);
 
double computeL2Error(const FiniteElementState& state, mfem::VectorCoefficient& exact_solution);
 
double computeL2Error(const FiniteElementState& state, mfem::Coefficient& exact_solution);
 
}  // namespace serac