common.hh

Go to the documentation of this file.

/*****************************************************************************
*   This program is part of the msbGrid software                            *
*                                                                           *
*   msbGrid stands for multi-structured block Grid generator                *
*                                                                           *
*   msbGrid is a free software: you can redistribute it and/or modify       *
*   it under the terms of the GNU General Public License as published by    *
*   the Free Software Foundation, either version 2 of the License, or       *
*   (at your option) any later version.                                     *
*                                                                           *
*   msbGrid 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 General Public License for more details.                            *
*                                                                           *
*   See the file COPYING for full copying permissions.                      *
*****************************************************************************/
#ifndef _COMMON_HH_
#define _COMMON_HH_

#include <iostream>
#include <cmath>
#include <limits>
#include <cstdlib>
#include <vector>

namespace msbGrid
{
typedef double Scalar;
enum { dim = 2 };

namespace Constants 
{
const Scalar PI = 4.0 * std :: atan(1.0);       /* in radiants */
const Scalar _PI = 180.0;                       /* in degrees */
const Scalar EPSILON = std :: numeric_limits< Scalar > :: epsilon();
const Scalar TOLERANCE = 1e2 * EPSILON;
}       /* namespace Constants */

enum Color 
{ Black, Blue, Green, Red, Cyan, Magenta, Yellow, White };

std :: string colorName(const Color &color) 
{
  std :: string res;
  switch ( color ) {
  case Black: res = "Black";
    break;
  case Blue: res = "Blue";
    break;
  case Green: res = "Green";
    break;
  case Red: res = "Red";
    break;
  case Cyan: res = "Cyan";
    break;
  case Magenta: res = "Magenta";
    break;
  case Yellow: res = "Yellow";
    break;
  case White: res = "White";
    break;
  default:
    std :: cerr << "error: colorName(.), not defined color = " << color << std :: endl;
    std :: exit(1);
  }

  return res;
}

std :: string colorSymbol(const Color &color) 
{
  std :: string res;
  switch ( color ) {
  case Black: res = "'k'";
    break;
  case Blue: res = "'b'";
    break;
  case Green: res = "'g'";
    break;
  case Red: res = "'r'";
    break;
  case Cyan: res = "'c'";
    break;
  case Magenta: res = "'m'";
    break;
  case Yellow: res = "'y'";
    break;
  case White: res = "'w'";
    break;
  default:
    std :: cerr << "error: colorSymbol(), not defined color!!, " << color << std :: endl;
    std :: exit(1);
  }

  return res;
}

const Color randomColor() 
{
  return Color( ( std :: rand() % 8 ) );

  /*
   * TODO :
   * implement more sophisticated color capabilities
   */
}

struct Marker
{
  std :: string symbol;
  int size;
  msbGrid :: Color edgeColor;
  msbGrid :: Color faceColor;
};

/*
 * random angle between 0 and 360 [degrees]
 */
const Scalar randomAngle() 
{
  return ( std :: rand() % 360 );
}

const Scalar deg2Rad(const Scalar &_angle) // [deg]
{
  return ( ( _angle / msbGrid :: Constants :: _PI ) * msbGrid :: Constants :: PI ); // [rad]
}

void periodicDistribution(std :: vector< std :: pair< Scalar, Scalar > > *blockCenter
                          , const Scalar &xMin, const Scalar &xMax, const Scalar &yMin, const Scalar &yMax
                          , const Scalar &dx, const Scalar &dy, const bool &verbose = true)
{
  const Scalar xBegin = xMin + dx / Scalar(2.0), yBegin = yMin + dy / Scalar(2.0);
  for ( Scalar x = xBegin; x <= xMax; x += dx ) {
    for ( Scalar y = yBegin; y <= yMax; y += dy ) {
      const std :: pair< Scalar, Scalar > p0(x, y);
      blockCenter->push_back(p0);
      if ( verbose ) {
        std :: cout << "x = " << x << " , y = " << y << "\n";
      }
    }
  }
}
}       /* namespace msbGrid */

#endif  /* #ifndef _COMMON_HH_ */