lib_grid_messages.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
#ifndef __H__UG__lib_grid_messages__
#define __H__UG__lib_grid_messages__
 
#include "common/util/message_hub.h"
#include "lib_grid/grid/grid_object_collection.h"
#include "lib_grid/algorithms/serialization.h"
 
namespace ug
{
 
enum GridMessageMultiGridChangedType{
  GMMGCT_LEVEL_ADDED = 1,
  GMMGCT_REMOVED = 2
};
 
class GridMessage_MultiGridChanged : public MessageHub::IMessage
{
  public:
    GridMessage_MultiGridChanged(GridMessageMultiGridChangedType msgType,
                   int numLevels) :
      m_msgType(msgType),
      m_numLevels(numLevels)
    {}
 
    GridMessageMultiGridChangedType message_type() const  {return m_msgType;}
 
    int num_levels_in_grid() const    {return m_numLevels;}
 
  private:
    GridMessageMultiGridChangedType m_msgType;
    int   m_numLevels;
};
 
 
enum GridMessageAdaptionType{
  GMAT_UNKNOWN = 0,
  GMAT_GLOBAL_ADAPTION_BEGINS,
  GMAT_HNODE_ADAPTION_BEGINS,
  GMAT_GLOBAL_ADAPTION_ENDS,
  GMAT_HNODE_ADAPTION_ENDS,
  GMAT_GLOBAL_REFINEMENT_BEGINS,
  GMAT_HNODE_REFINEMENT_BEGINS,
  GMAT_GLOBAL_REFINEMENT_ENDS,
  GMAT_HNODE_REFINEMENT_ENDS,
  GMAT_GLOBAL_COARSENING_BEGINS,
  GMAT_HNODE_COARSENING_BEGINS,
  GMAT_GLOBAL_COARSENING_ENDS,
  GMAT_HNODE_COARSENING_ENDS
};
 
class GridMessage_Adaption : public MessageHub::IMessage
{
  public:
    GridMessage_Adaption(GridMessageAdaptionType adaptionType) :
      m_adaptionType(adaptionType)  {}
 
    GridMessage_Adaption(GridMessageAdaptionType adaptionType,
               const GridObjectCollection& affectedElements) :
      m_adaptionType(adaptionType),
      m_affectedElements(affectedElements){}
 
    GridMessageAdaptionType adaption_type() const {return m_adaptionType;}
 
 
    bool adaption_begins() const;
    bool adaption_ends() const;
 
    bool step_begins() const;
    bool step_ends() const;
    bool adaptive() const;
 
    bool global() const;
 
 
    bool refinement() const;
 
 
    bool coarsening() const;
 
 
    const GridObjectCollection& affected_elements() const {return m_affectedElements;}
 
  protected:
    GridMessageAdaptionType   m_adaptionType;
    GridObjectCollection  m_affectedElements;
};
 
 
enum GridMessageDistributionType{
  GMDT_NONE,
  GMDT_DISTRIBUTION_STARTS,
  GMDT_DISTRIBUTION_STOPS
};
 
class GridMessage_Distribution : public MessageHub::IMessage
{
  public:
    GridMessage_Distribution(GridMessageDistributionType msg,
                 GridDataSerializationHandler& gdsh) :
      m_msg(msg),
      m_serializationHandler(gdsh)
    {}
 
    GridMessageDistributionType msg() const {return m_msg;}
 
    GridDataSerializationHandler& serialization_handler() const
    {
      return m_serializationHandler;
    }
 
  private:
    GridMessageDistributionType   m_msg;
    GridDataSerializationHandler& m_serializationHandler;
};
 
 
enum GridMessageCreationType{
  GMCT_NONE,
  GMCT_CREATION_STARTS,
  GMCT_CREATION_STOPS
};
 
class GridMessage_Creation : public MessageHub::IMessage
{
  public:
    GridMessage_Creation(GridMessageCreationType msg = GMCT_NONE, int procId = -1) :
      m_msg(msg), m_procId(procId)  {}
 
    GridMessageCreationType msg() const {return m_msg;}
    int proc_id() const         {return m_procId;}
 
  private:
    GridMessageCreationType m_msg;
    int m_procId;
};
 
}// end of namespace
 
#endif