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

tamaas/src/surface_generator.hh
ab4ed84013a6ci-fix-static-checks

Last Change
Raw File

surface_generator.hh
View Options

/**
*
* @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_H
#define SURFACE_GENERATOR_H
/* -------------------------------------------------------------------------- */
#include "surface.hh"
#include <sstream>
#include <iostream>
#include <string>
#include <algorithm>
/* -------------------------------------------------------------------------- */
__BEGIN_TAMAAS__
class SurfaceGenerator {
public:
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
//! default constructor
SurfaceGenerator();
//! default destructor
virtual ~SurfaceGenerator(){
delete surface;
};
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
//! Build surface profile (array of heights)
virtual Surface<Real> & buildSurface()=0;
virtual void Init();
Real constrainRMS();
protected:
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
public:
int & getGridSize(){return gridsize;};
void setGridSize(int gsz){this->gridsize = gsz;};
Real & getRMS(){return rms;};
long & getRandomSeed(){return random_seed;};
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected:
Real rms; /* The RMS for the rough surface */
long random_seed; /* A random seed */
Surface<Real> * surface;
int gridsize;
};
/* -------------------------------------------------------------------------- */
__END_TAMAAS__
#endif
c4science · Help