weak_form.hpp

Go to the documentation of this file.

// Copyright (c) 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 <vector>
#include <string>
#include <memory>
#include "serac/physics/common.hpp"
#include "serac/physics/field_types.hpp"
 
namespace mfem {
class Vector;
class HypreParMatrix;
}  // namespace mfem
 
namespace serac {
 
class FiniteElementState;
class FiniteElementDual;
 
using QuadratureField = double;                 
using QuadratureFieldPtr = double*;             
using ConstQuadratureFieldPtr = const double*;  
 
class WeakForm {
 public:
  WeakForm(std::string name) : name_(name) {}
 
  virtual ~WeakForm() {}
 
  virtual mfem::Vector residual(double time, double dt, ConstFieldPtr shape_disp,
                                const std::vector<ConstFieldPtr>& fields,
                                const std::vector<ConstQuadratureFieldPtr>& quad_fields = {},
                                int block_row = 0) const = 0;
 
  virtual std::unique_ptr<mfem::HypreParMatrix> jacobian(double time, double dt, ConstFieldPtr shape_disp,
                                                         const std::vector<ConstFieldPtr>& fields,
                                                         const std::vector<double>& field_argument_tangents,
                                                         const std::vector<ConstQuadratureFieldPtr>& quad_fields = {},
                                                         int block_row = 0) const = 0;
 
  virtual void jvp(double time, double dt, ConstFieldPtr shape_disp, const std::vector<ConstFieldPtr>& fields,
                   const std::vector<ConstQuadratureFieldPtr>& quad_fields, ConstFieldPtr v_shape_disp,
                   const std::vector<ConstFieldPtr>& v_fields,
                   const std::vector<ConstQuadratureFieldPtr>& v_quad_fields,
                   const std::vector<DualFieldPtr>& jvp_reactions) const = 0;
 
  virtual void vjp(double time, double dt, ConstFieldPtr shape_disp, const std::vector<ConstFieldPtr>& fields,
                   const std::vector<ConstQuadratureFieldPtr>& quad_fields, const std::vector<ConstFieldPtr>& v_fields,
                   DualFieldPtr vjp_shape_disp_sensitivity, const std::vector<DualFieldPtr>& vjp_sensitivities,
                   const std::vector<QuadratureFieldPtr>& vjp_quadrature_sensivities) const = 0;
 
  std::string name() const { return name_; }
 
 private:
  std::string name_;
};
 
}  // namespace serac