common_attachments.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-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.
 */
 
//  In this file attachments are defined that are commonly used by libGrid.
 
#ifndef __H__LIB_GRID__COMMON_ATTACHMENTS__
#define __H__LIB_GRID__COMMON_ATTACHMENTS__
 
#include "common/types.h"
#include "lib_grid/attachments/attachment_pipe.h"
#include "lib_grid/attachments/attachment_info_traits.h"
#include "common/math/ugmath_types.h"
#include "grid/grid_base_objects.h"
 
namespace ug
{
 
//  attachment-types
typedef Attachment<bool>    ABool;
typedef Attachment<char>    AChar;
typedef Attachment<byte>    AByte;
typedef Attachment<int>     AInt;
typedef Attachment<uint>    AUInt;
typedef Attachment<number>    ANumber;
typedef  Attachment<float>    AFloat;
typedef Attachment<double>    ADouble;
typedef Attachment<vector1>   AVector1;
typedef Attachment<vector2>   AVector2;
typedef Attachment<vector3>   AVector3;
typedef Attachment<vector4>   AVector4;
typedef Attachment<Vertex*>   AVertex;
typedef Attachment<Edge*>   AEdge;
typedef Attachment<Face*>   AFace;
typedef Attachment<Volume*>   AVolume;
 
typedef AVector1  APosition1;
typedef AVector2  APosition2;
typedef AVector3  ANormal2;
typedef AVector3  APosition3;
typedef AVector3  ANormal3;
typedef AVector2  ATexCoord;
 
typedef APosition3  APosition;
typedef ANormal3  ANormal;
 
 
//  concrete attachments
UG_API
extern APosition  aPosition;
UG_API
extern APosition2 aPosition2;
UG_API
extern APosition1 aPosition1;
 
UG_API
extern ANormal    aNormal;
 
//  default position attachments for different types
 
template <class TAttachment>
UG_API
inline
TAttachment&
GetDefaultPositionAttachment();
 
 
//  dimension of Position Attachment
template <typename TAPos>
UG_API
inline int GetPositionAttachmentDimension();
 
 
}// end of namespace
 
 
//  include implementation
#include "common_attachments_impl.hpp"
 
#endif