shapes.h++

Go to the documentation of this file.

/*


    Copyright (C) 2009 Joseph Pingenot

    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 <http://www.gnu.org/licenses/>.


*/

#include <glib.h>
#include <libmodelxx/function_specification.h++>

#ifndef SHAPES_HXX__
#define SHAPES_HXX__

namespace kdotp {
  namespace libmodelxx {
    namespace grid {


      /*Enum contaning types of shapes we support
       *Shapes supported thus far:
       *  BLOCK: A "relatively positioned" block (center, width)
       *  ABSBLOCK: Absolutely positioned block (corner, opposite corner)
       *  DEFAULT: used when no other shape is specified.
       */
      enum shape_type {
  INVALID=-1,
  GLOBAL,       //Puts this material everywhere
  BLOCK,          //Block type shape
  ABSBLOCK      //Absolutely-positioned Block type shape
      };

      /*How to combine shapes*/
      enum shape_operation {
  OR,             //Total shape is an OR of the individual shapes
  XOR,
  AND,
  NOT,             //Unary not; operatos on l, not r (r=NULL)
  LEAF             //special "type"; a LEAF is just a plain shape.
      };

      /*Specifies a shape*/
      struct shape {
  /*How to combine the two shapes
   *NOTE: THIS MUST BE 'LEAF' here.
   */
  enum shape_operation op;
  /*Type of shape*/
  enum shape_type type;
  /*Is this a generic shape*/
  bool generic;
  /*Shape descriptor. The meaning of this is dependent upon the
    shape type. It is simply a list of functions.
    Units are nanometers
  */
  GList *descriptor;
      };
      /**
       * Specific types of shapes
       *\note shape_block is used for both a block and an absblock.
       *\note center and L are just two coordinate for an absblock.
       */
      struct shape_block {
  enum shape_operation op;
  enum shape_type type;
  bool generic;
  /*Coordinates in Cartesian real space of the center of the box*/
	::kdotp::libmodelxx::postprocessing::function_exp* center;
  /*Length of a box edge, in Cartesian real space*/
	::kdotp::libmodelxx::postprocessing::function_exp* L;
      };
      struct shape_global {
  enum shape_operation op;
  enum shape_type type;
  bool generic;
      };

      struct shape_tree {
  /*How to combine the two shapes*/
  enum shape_operation op;
  /*The shapes to be operated on: left, right*/
  struct shape_tree *l;
  struct shape_tree *r;
      };

      /*
       *Sets up and verifies a shape tree that was given by */
      struct shape_tree* postprocess_shape_tree(struct shape_tree* st, int dim);


      /*Frees a shape tree (includes just one shape)*/
      void shape_tree_free(struct shape_tree *st);

      /*Frees a specific shape instance*/
      void shape_free(struct shape *s);


      enum shape_type get_shape_from_identifier(const char* identifier);

      void get_string_from_shape_type(char** str, enum shape_type t);

    }
  }
}
#endif