potential.hpp

Go to the documentation of this file.

/*
 * This file is part of BubbleProfiler.
 *
 * BubbleProfiler is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * BubbleProfiler 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with BubbleProfiler.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef BUBBLEPROFILER_POTENTIAL_HPP_INCLUDED
#define BUBBLEPROFILER_POTENTIAL_HPP_INCLUDED

#include <cstddef>

#include <Eigen/Core>

namespace BubbleProfiler {


class Potential {
public:
   virtual ~Potential() = default;

   virtual Potential * clone() const = 0;


   virtual double operator()(const Eigen::VectorXd& coords) const = 0;


   virtual double partial(const Eigen::VectorXd& coords, int i) const = 0;


   virtual double partial(const Eigen::VectorXd& coords, int i, int j) const = 0;

   virtual std::size_t get_number_of_fields() const = 0;


   virtual void translate_origin(const Eigen::VectorXd &translation) = 0;


   virtual void apply_basis_change(const Eigen::MatrixXd& cob_matrix) = 0;


   virtual void add_constant_term(double offset) = 0;
};

} // namespace BubbleProfiler

#endif