* Welcome to Tamaas, the Rough surface toolkit of LSMS
* Build
The build system uses SCons. In order to construct the library you should hit:

scons

And to speedup the process you can do:

scons -j 6

In order to clean the build

scons -c

In order to compile in debug

scons build_type=debug

Indeed the default was

scons build_type=release


In order to make the compilation more verbose

scons verbose=true

* Coding
All classes and functions in Tamaas live in the `tamaas` namespace. Here is an example main:

#+NAME: Example main
#+BEGIN_SRC c++
using namespace tamaas;
int main (int argc, char * argv[]) {
  // Initializing tamaas
  initialize();

  // Surface parameters
  const UInt grid_size = 1024;
  const UInt k0 = 4, k1 = 4, k2 = 32;
  const Real hurst = 0.8;
  const Real rms = 0.1;

  // Surface generator
  SurfaceGeneratorFilterFFT sg;
  sg.getGridSize() = grid_size;
  sg.getQ0() = k0;
  sg.getQ1() = k1;
  sg.getQ2() = k2;
  sg.getRMS() = rms;
  sg.getHurst() = hurst;
  sg.getRandomSeed() = 56;
  sg.Init();

  Surface<Real> & surface = sg.buildSurface();

  // BEM object
  BemPolonski bem(surface);
  bem.setEffectiveModulus(1.);

  // Solving equilibrium
  Real load = 0.01;
  bem.computeEquilibrium(1e-12, load);

  Surface<Real> & tractions = bem.getTractions();
  Surface<Real> & displacements = bem.getDisplacements();

  // Cleaning up tamaas
  finalize();
}
#+END_SRC

Tamaas also has a python interface. Here is an example:

#+NAME: Python example
#+BEGIN_SRC python
import numpy as np
import tamaas as tm

tm.initialize()

# Surface generation
SG = tm.SurfaceGeneratorFilterFFT()
SG.getGridSize().assign(512)
SG.getHurst().assign(0.8)
SG.getRMS().assign(1.);
SG.getQ0().assign(4);
SG.getQ1().assign(4);
SG.getQ2().assign(32);
SG.getRandomSeed().assign(156);
SG.Init()
surface = SG.buildSurface()

bem = tm.BemPolonski(surface)
bem.setEffectiveModulus(1.)

load = 0.01
bem.computeEquilibrium(1e-12, load)

tractions = bem.getTractions()
displacements = bem.getDisplacements()

tm.finalize()
#+END_SRC

* Paralellism
Tamaas features shared-memory paralellism with OpenMP. The number of threads can be
controlled via the `OMP_NUM_THREADS` environement variable or the `omp_set_num_thread()`
function in the OpenMP API.