scalar_objective.hpp

Go to the documentation of this file.

// Copyright Lawrence Livermore National Security, LLC and
// other Smith Project Developers. See the top-level LICENSE file for
// details.
//
// SPDX-License-Identifier: (BSD-3-Clause)
 
#pragma once
 
#include <vector>
#include "smith/physics/common.hpp"
#include "smith/physics/field_types.hpp"
 
namespace mfem {
class Vector;
}  // namespace mfem
 
namespace smith {
 
class FiniteElementState;
 
class ScalarObjective {
 public:
  ScalarObjective(const std::string& name) : name_(name) {}
 
  virtual ~ScalarObjective() {}
 
  virtual double evaluate(TimeInfo time_info, ConstFieldPtr shape_disp,
                          const std::vector<ConstFieldPtr>& fields) const = 0;
 
  virtual mfem::Vector gradient(TimeInfo time_info, ConstFieldPtr shape_disp, const std::vector<ConstFieldPtr>& fields,
                                size_t field_ordinal) const = 0;
 
  virtual mfem::Vector gradient(TimeInfo time_info, ConstFieldPtr shape_disp, const std::vector<ConstFieldPtr>& fields,
                                int field_ordinal) const
  {
    return gradient(time_info, shape_disp, fields, static_cast<size_t>(field_ordinal));
  }
 
  virtual mfem::Vector mesh_coordinate_gradient(TimeInfo time_info, ConstFieldPtr shape_disp,
                                                const std::vector<ConstFieldPtr>& fields) const = 0;
 
  std::string name() const { return name_; }
 
 private:
  std::string name_;
};
 
}  // namespace smith