Homec4science
Diffusion tamaas (ci-fix-static-checks) Browse

tamaas/src/surface/surface_generator.hh
54673fc2b3c4ci-fix-static-checks

Last Change
Raw File

surface_generator.hh
View Options

/**
* @file
*
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
*
* @section LICENSE
*
* Copyright (©) 2016 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 __SURFACE_GENERATOR_HH__
#define __SURFACE_GENERATOR_HH__
/* -------------------------------------------------------------------------- */
#include "grid.hh"
/* -------------------------------------------------------------------------- */
__BEGIN_TAMAAS__
/// Class generating random surfaces
template <UInt dim>
class SurfaceGenerator {
public:
/// Default constructor
SurfaceGenerator() = default;
/// Default destructor
virtual ~SurfaceGenerator() = default;
public:
/// Build surface profile (array of heights)
virtual Grid<Real, dim>& buildSurface() = 0;
/// Set surface sizes
void setSizes(const std::array<UInt, dim>& n);
/// Set surface sizes
void setSizes(const UInt n[dim]);
TAMAAS_ACCESSOR(random_seed, long, RandomSeed);
/// Maintaining old interface
friend class SurfaceGeneratorFilterFFT;
protected:
Grid<Real, dim> grid;
long random_seed = 0;
};
/* -------------------------------------------------------------------------- */
__END_TAMAAS__
#endif // __SURFACE_GENERATOR_HH__
c4science · Help