script_interface/constraints/HomogeneousMagneticField.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2022 The ESPResSo project
 * Copyright (C) 2002,2003,2004,2005,2006,2007,2008,2009,2010
 *   Max-Planck-Institute for Polymer Research, Theory Group
 *
 * This file is part of ESPResSo.
 *
 * ESPResSo 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.
 *
 * ESPResSo 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "core/constraints/Constraint.hpp"
#include "core/constraints/HomogeneousMagneticField.hpp"
 
#include "script_interface/ScriptInterface.hpp"
#include "script_interface/constraints/Constraint.hpp"
 
#include <utils/Vector.hpp>
 
#include <memory>
 
namespace ScriptInterface {
namespace Constraints {
 
class HomogeneousMagneticField : public Constraint {
public:
  HomogeneousMagneticField()
      : m_constraint(
            std::make_shared<::Constraints::HomogeneousMagneticField>()) {
    add_parameters({{"H",
                     [this](Variant const &v) {
                       m_constraint->set_H(get_value<Utils::Vector3d>(v));
                     },
                     [this]() { return m_constraint->H(); }}});
  }
 
  std::shared_ptr<::Constraints::Constraint> constraint() override {
    return std::static_pointer_cast<::Constraints::Constraint>(m_constraint);
  }
  std::shared_ptr<const ::Constraints::Constraint> constraint() const override {
    return std::static_pointer_cast<::Constraints::Constraint>(m_constraint);
  }
  std::shared_ptr<::Constraints::HomogeneousMagneticField>
  homogeneous_magnetic_field() const {
    return m_constraint;
  }
 
private:
  /* The actual constraint */
  std::shared_ptr<::Constraints::HomogeneousMagneticField> m_constraint;
};
 
} /* namespace Constraints */
} /* namespace ScriptInterface */