Homec4science
Diffusion tamaas (features/materials) Browse

tamaas/python/wrap.hh
4ef018c79b67features/materials

Last Change
Raw File

wrap.hh
View Options

/**
* @file
*
* @author Lucas Frérot <lucas.frerot@epfl.ch>
*
* @section LICENSE
*
* Copyright (©) 2017 EPFL (Ecole Polytechnique Fédérale de
* Lausanne) Laboratory (LSMS - Laboratoire de Simulation en Mécanique des
* Solides)
*
* Tamaas is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* Tamaas 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 Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Tamaas. If not, see <http://www.gnu.org/licenses/>.
*
*/
/* -------------------------------------------------------------------------- */
#ifndef __WRAP_HH__
#define __WRAP_HH__
/* -------------------------------------------------------------------------- */
#include "grid.hh"
#include "surface.hh"
#include "tamaas.hh"
/* -------------------------------------------------------------------------- */
#include <pybind11/pybind11.h>
// keep order
#include <pybind11/cast.h>
#include <pybind11/numpy.h>
/* -------------------------------------------------------------------------- */
namespace tamaas {
namespace wrap {
namespace py = pybind11;
template <typename T>
using numpy = py::array_t<T, py::array::c_style | py::array::forcecast>;
/// Class wrapping a numpy array
template <class Parent>
class GridNumpy : public Parent {
public:
GridNumpy(numpy<typename Parent::value_type>& buffer) : Parent() {
auto* array_shape = buffer.shape();
if (buffer.ndim() > Parent::dimension + 1 ||
buffer.ndim() < Parent::dimension)
TAMAAS_EXCEPTION(
"Numpy array dimension do not match expected grid dimensions");
if (buffer.ndim() == Parent::dimension + 1)
this->nb_components = array_shape[buffer.ndim() - 1];
std::copy_n(array_shape, Parent::dimension, this->n.begin());
this->computeStrides();
this->data.wrapMemory(buffer.mutable_data(), this->computeSize());
}
};
/// Class wrapping a numpy array
template <class Parent>
class SurfaceNumpy : public Parent {
public:
SurfaceNumpy(numpy<typename Parent::value_type>& buffer) : Parent() {
auto* array_shape = buffer.shape();
if (buffer.ndim() != 2)
TAMAAS_EXCEPTION(
"Numpy array dimension do not match expected surface dimensions");
std::copy_n(array_shape, Parent::dimension, this->n.begin());
this->computeStrides();
this->data.wrapMemory(buffer.mutable_data(), this->computeSize());
}
};
} // namespace wrap
} // namespace tamaas
/* -------------------------------------------------------------------------- */
namespace pybind11 {
namespace detail {
/**
* Type caster for grid classes
* inspired by https://tinyurl.com/y8m47qh3 from T. De Geus
* and pybind11/eigen.h
*/
template <template <typename, unsigned int> class G, typename T,
unsigned int dim>
struct type_caster<G<T, dim>> {
using type = G<T, dim>;
template <typename U>
using array_type = array_t<U, array::c_style | array::forcecast>;
public:
PYBIND11_TYPE_CASTER(type, _("GridWrap<T, dim>"));
/**
* Conversion part 1 (Python->C++): convert a PyObject into a grid
* instance or return false upon failure. The second argument
* indicates whether implicit conversions should be applied.
*/
bool load(handle src, bool convert) {
if (!convert && !array_type<T>::check_(src))
return false;
auto buf = array_type<T>::ensure(src);
value.move(tamaas::wrap::GridNumpy<G<T, dim>>(buf));
return true;
}
/**
* Conversion part 2 (C++ -> Python): convert a grid instance into
* a Python object. The second and third arguments are used to
* indicate the return value policy and parent object (for
* ``return_value_policy::reference_internal``) and are generally
* ignored by implicit casters.
*/
static handle cast(const type& src, return_value_policy /* policy */,
handle /*parent*/) {
if (src.getNbComponents() == 1) {
auto a = array_type<T>(src.sizes(), src.getInternalData(), none());
return a.release();
} else {
std::array<unsigned int, dim> sizes;
std::copy_n(src.sizes().begin(), dim, sizes.begin());
sizes.back() = src.getNbComponents();
auto a = array_type<T>(sizes, src.getInternalData(), none());
return a.release();
}
}
};
template <typename T>
struct type_caster<tamaas::Surface<T>> {
using type = tamaas::Surface<T>;
template <typename U>
using array_type = array_t<U, array::c_style | array::forcecast>;
public:
PYBIND11_TYPE_CASTER(type, _("SurfaceWrap<T, dim>"));
/**
* Conversion part 1 (Python->C++): convert a PyObject into a grid
* instance or return false upon failure. The second argument
* indicates whether implicit conversions should be applied.
*/
bool load(handle src, bool convert) {
if (!convert && !array_type<T>::check_(src))
return false;
auto buf = array_type<T>::ensure(src);
value.move(tamaas::wrap::SurfaceNumpy<type>(buf));
return true;
}
/**
* Conversion part 2 (C++ -> Python): convert a grid instance into
* a Python object. The second and third arguments are used to
* indicate the return value policy and parent object (for
* ``return_value_policy::reference_internal``) and are generally
* ignored by implicit casters.
*/
static handle cast(const type& src, return_value_policy /* policy */,
handle /*parent*/) {
auto a = array_type<T>(src.sizes(), src.getInternalData(), none());
return a.release();
}
};
} // namespace detail
} // namespace pybind11
/* -------------------------------------------------------------------------- */
__BEGIN_TAMAAS__
namespace wrap {
inline std::string makeDimensionName(const std::string& name, UInt dim) {
std::stringstream str;
str << name << dim << "D";
return str.str();
}
/* -------------------------------------------------------------------------- */
void wrapCore(py::module& mod);
void wrapPercolation(py::module& mod);
void wrapSurface(py::module& mod);
/* -------------------------------------------------------------------------- */
} // namespace wrap
__END_TAMAAS__
#endif // __WRAP_HH__
c4science · Help