Homec4science
Diffusion tamaas (feature/mpi_fft_engine) Browse

tamaas/src/core/surface.hh
0670ef204b92feature/mpi_fft_engine

Last Change
Raw File

surface.hh
View Options

/**
* @file
* @section LICENSE
*
* Copyright (©) 2016-2020 EPFL (École Polytechnique Fédérale de Lausanne),
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
/* -------------------------------------------------------------------------- */
/* -------------------------------------------------------------------------- */
#ifndef __SURFACE_HH__
#define __SURFACE_HH__
/* -------------------------------------------------------------------------- */
#include <complex>
#include <iostream>
#include <limits>
#include <string>
/* -------------------------------------------------------------------------- */
#include "grid.hh"
/* -------------------------------------------------------------------------- */
namespace tamaas {
/**
* @deprecated should use Grid class instead
* @brief Square 2D surface class
*/
template <typename T>
class Surface : public Grid<T, 2> {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
using Grid<T, 2>::Grid;
Surface(UInt a, Real L) : Grid<T, 2>() {
setGridSize(a);
setL(L);
}
Surface(const Surface& o) : Grid<T, 2>(o) {}
Surface(Surface&& o) noexcept : Grid<T, 2>(std::move(o)) {}
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
//! set the grid size
void setGridSize(UInt n) { this->resize({n, n}); }
//! get lateral number of discretization points
inline UInt size() const { return this->n[0]; };
//! get the lateral size of the sample
inline Real getL() const { return 1.; };
//! get the lateral size of the sample
inline void setL(Real) {}
Surface& operator=(T val) {
Grid<T, 2>::operator=(val);
return *this;
}
Surface& operator=(const Surface& o) {
Grid<T, 2>::operator=(o);
return *this;
}
Surface& operator=(Surface&& o) noexcept {
Grid<T, 2>::operator=(std::move(o));
return *this;
}
//! Write VTU file that is a set of points
void dumpToParaview(std::string filename) const;
//! create a new surface with linear interpolated points
void expandByLinearInterpolation();
//! create a new surface with linear interpolated points
void expandByShannonInterpolation(int factor);
//! create a new surface with mirroring
void expandByMirroring();
//! create a new surface with mirroring
void expandByPuttingZeros();
//! contract the surface by ignoring extra data
void contractByIgnoringMidPoints();
//! contract the surface by taking left bottom part of it
void contractByTakingSubRegion();
// recenter the heights to zero value
void recenterHeights();
// set all the members of the map to a given value
static void generateWhiteNoiseSurface(Surface<Real>& surface,
long random_seed);
virtual const Surface<T>& getWrappedNumpy() { return *this; };
};
/* -------------------------------------------------------------------------- */
/* -------------------------------------------------------------------------- */
/* -------------------------------------------------------------------------- */
} // namespace tamaas
#include "surface_complex.hh"
#endif /* __SURFACE_HH__ */
c4science · Help