FiniteElemSpace.h

/******************************************************************************
 *
 * AMDiS - Adaptive multidimensional simulations
 *
 * Copyright (C) 2013 Dresden University of Technology. All Rights Reserved.
 * Web: https://fusionforge.zih.tu-dresden.de/projects/amdis
 *
 * Authors:
 * Simon Vey, Thomas Witkowski, Andreas Naumann, Simon Praetorius, et al.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 *
 * This file is part of AMDiS
 *
 * See also license.opensource.txt in the distribution.
 *
 ******************************************************************************/



/** \file FiniteElemSpace.h */

/** \defgroup FEMSpace FEMSpace
 * @{ <img src="femspace.png"> @}
 */

#ifndef AMDIS_FINITEELEMSPACE_H
#define AMDIS_FINITEELEMSPACE_H

#include <string>
#include <vector>
#include "AMDiS_fwd.h"

namespace AMDiS {

  /** \ingroup FEMSpace
   * \brief
   * A FiniteElemSpace is a triple of a DOFAdmin and a set of BasisFunction on a mesh.
   */
  class FiniteElemSpace
  {
  public:
    /// Create an empty fe space.
    FiniteElemSpace();

    ///
    static FiniteElemSpace *provideFeSpace(DOFAdmin *admin,
					   const BasisFunction *basFcts,
					   Mesh *mesh,
					   std::string name = "");

    static void destroyFeSpaces();

#ifndef NDEBUG
    /// For debugging it may be useful to get some FE space for a given mesh at a
    /// position in code where it is not possible to access the FE space directly. The
    /// function assumes that there is only one FE space defined for the mesh.

    static FiniteElemSpace *provideFeSpace(Mesh *mesh);
#endif

    /// Destructor.
    ~FiniteElemSpace();

    FiniteElemSpace& operator=(const FiniteElemSpace& feSpace);

    /// Returns \ref name.
    inline std::string getName() const
    {
      return name;
    }

    /// Returns \ref admin.
    inline DOFAdmin* getAdmin() const
    {
      return admin;
    }

    /// Set a new DOF admin.
    inline void setAdmin(DOFAdmin* a)
    {
      admin = a;
    }

    /// Returns \ref basFcts
    inline const BasisFunction* getBasisFcts() const
    {
      return basFcts;
    }

    /// Returns \ref mesh
    inline Mesh* getMesh() const
    {
      return mesh;
    }

    int calcMemoryUsage();

    static void clear();

    /// Returns for a set of FE spaces that FE space having basis functions with
    /// the highest degree.
    static const FiniteElemSpace*
    getHighest(std::vector<const FiniteElemSpace*>& feSpaces);

  protected:
    /// Constructs a FiniteElemSpace with name name_ and the given DOFAdmin,
    /// BasisFunction and Mesh.
    FiniteElemSpace(DOFAdmin* admin,
		    const BasisFunction* basisFcts,
		    Mesh* mesh,
		    std::string name = "");

  protected:
    /// Name of this FiniteElemSpace.
    const std::string name;

    /// DOFAdmin corresponding to this FiniteElemSpace.
    DOFAdmin* admin;

    /// Set of BasisFunction of this FiniteElemSpace.
    const BasisFunction* basFcts;

    /// The Mesh this FiniteElemSpace belongs to.
    Mesh* mesh;

    ///
    static std::vector<FiniteElemSpace*> feSpaces;
  };

}

#endif  // !_FINITEELEMSPACE_H_