dof_distribution_info.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * 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_DISC__DOF_MANAGER__DOF_DISTRIBUTION_INFO__
#define __H__UG__LIB_DISC__DOF_MANAGER__DOF_DISTRIBUTION_INFO__
 
#include "common/common.h"
#include "lib_grid/lg_base.h"
#include "lib_disc/dof_manager/function_pattern.h"
#include "lib_disc/local_finite_element/local_finite_element_id.h"
#include "lib_disc/local_finite_element/local_dof_set.h"
 
#include <vector>
 
namespace ug{
 
class DoFDistributionInfo : public FunctionPattern
{
  public:
    enum{NOT_DEF_ON_SUBSET = (size_t) - 1};
    enum{NOT_YET_ASSIGNED = (size_t) - 2};
    enum{NOT_SPECIFIED = CommonLocalDoFSet::NOT_SPECIFIED};
 
  public:
    DoFDistributionInfo(ConstSmartPtr<ISubsetHandler> spSH);
 
    void init();
 
 
    size_t max_dofs(const int dim) const {return m_vMaxDoFsInDim[dim];}
 
    size_t max_dofs(const GridBaseObjectId gbo) const {return m_vMaxDoFsInDim[gbo];}
 
    size_t max_dofs(const ReferenceObjectID roid) const {return m_vMaxDoFsOnROID[roid];}
 
    size_t max_dofs(const int dim, const int si) const {return m_vvMaxDoFsInDimPerSubset[dim][si];}
 
    size_t max_dofs(const GridBaseObjectId gbo, const int si) const {return m_vvMaxDoFsInDimPerSubset[gbo][si];}
 
    size_t num_dofs(const ReferenceObjectID roid, const int si) const {return m_vvNumDoFsOnROIDPerSubset[roid][si];}
 
 
    size_t max_fct_dofs(const size_t fct, int dim) const {return m_vFctInfo[fct].vMaxDoFsInDim[dim];}
 
    size_t max_fct_dofs(const size_t fct, const GridBaseObjectId gbo) const {return m_vFctInfo[fct].vMaxDoFsInDim[gbo];}
 
    size_t max_fct_dofs(const size_t fct, const ReferenceObjectID roid) const {return m_vFctInfo[fct].vMaxDoFsOnROID[roid];}
 
    size_t max_fct_dofs(const size_t fct, const int dim, const int si) const {return m_vFctInfo[fct].vvMaxDoFsInDimPerSubset[dim][si];}
 
    size_t max_fct_dofs(const size_t fct, const GridBaseObjectId gbo, const int si) const {return m_vFctInfo[fct].vvMaxDoFsInDimPerSubset[gbo][si];}
 
    size_t num_fct_dofs(const size_t fct, const ReferenceObjectID roid, const int si) const {return m_vFctInfo[fct].vvNumDoFsOnROIDPerSubset[roid][si];}
 
 
    size_t offset(const ReferenceObjectID roid, const int si, const size_t fct) const {return m_vFctInfo[fct].vvOffsets[roid][si];}
 
 
    void print_local_dof_statistic(int verboseLev) const;
 
    void print_local_dof_statistic() const {print_local_dof_statistic(1);}
 
  protected:
    void create_offsets();
 
  protected:
    size_t m_vMaxDoFsInDim[NUM_GEOMETRIC_BASE_OBJECTS];
 
    size_t m_vMaxDoFsOnROID[NUM_REFERENCE_OBJECTS];
 
    std::vector<size_t> m_vvMaxDoFsInDimPerSubset[NUM_GEOMETRIC_BASE_OBJECTS];
 
    std::vector<size_t> m_vvNumDoFsOnROIDPerSubset[NUM_REFERENCE_OBJECTS];
 
 
    struct FctInfo{
      size_t vMaxDoFsInDim[NUM_GEOMETRIC_BASE_OBJECTS];
 
      size_t vMaxDoFsOnROID[NUM_REFERENCE_OBJECTS];
 
      std::vector<size_t> vvMaxDoFsInDimPerSubset[NUM_GEOMETRIC_BASE_OBJECTS];
 
      std::vector<size_t> vvNumDoFsOnROIDPerSubset[NUM_REFERENCE_OBJECTS];
 
      std::vector<size_t> vvOffsets[NUM_REFERENCE_OBJECTS];
    };
 
    std::vector<FctInfo> m_vFctInfo;
};
 
 
class DoFDistributionInfoProvider{
  public:
    DoFDistributionInfoProvider(ConstSmartPtr<DoFDistributionInfo> spDDI)
      : m_spDDI(spDDI)
    {}
 
    DoFDistributionInfoProvider() : m_spDDI(0) {}
 
    void set_dof_distribution_info(ConstSmartPtr<DoFDistributionInfo> spDDI) {m_spDDI = spDDI;}
 
    ConstSmartPtr<DoFDistributionInfo> dof_distribution_info() const {return m_spDDI;}
 
    ConstSmartPtr<ISubsetHandler> subset_handler() const {return m_spDDI->subset_handler();}
 
    ConstSmartPtr<FunctionPattern> function_pattern() const {return m_spDDI;}
 
 
    size_t num_fct() const {return m_spDDI->num_fct();}
 
    size_t num_fct(int si) const {return m_spDDI->num_fct(si);}
 
    std::string name(size_t fct) const {return m_spDDI->name(fct);}
 
    std::vector<std::string> names() const {return m_spDDI->names();}
 
    size_t fct_id_by_name(const char* name) const{return m_spDDI->fct_id_by_name(name);}
 
 
    int num_subsets() const {return m_spDDI->num_subsets();}
 
    int dim(size_t fct) const {return m_spDDI->dim(fct);}
 
    int dim_subset(int si) const {return m_spDDI->dim_subset(si);}
 
    std::string subset_name(int si) const {return m_spDDI->subset_name(si);}
 
    int subset_id_by_name(const char* name) const {return m_spDDI->subset_id_by_name(name);}
 
    SubsetGroup subset_grp_by_name(const char* names) const;
 
    SubsetGroup all_subsets_grp_except_for(const char* names) const;
 
    FunctionGroup fct_grp_by_name(const char* names) const;
 
 
    bool is_def_in_subset(size_t fct, int si) const {return m_spDDI->is_def_in_subset(fct,si);}
 
    bool is_def_everywhere(size_t fct) const {return m_spDDI->is_def_everywhere(fct);}
 
 
    const LFEID& local_finite_element_id(size_t fct) const {return m_spDDI->local_finite_element_id(fct);}
    const LFEID& lfeid(size_t fct) const {return m_spDDI->lfeid(fct);}
 
 
    size_t max_dofs(const int dim) const {return m_spDDI->max_dofs(dim);}
 
    size_t max_dofs(const GridBaseObjectId gbo) const {return m_spDDI->max_dofs(gbo);}
 
    size_t max_dofs(const ReferenceObjectID roid) const {return m_spDDI->max_dofs(roid);}
 
    size_t max_dofs(const int dim, const int si) const {return m_spDDI->max_dofs(dim, si);}
 
    size_t max_dofs(const GridBaseObjectId gbo, const int si) const {return m_spDDI->max_dofs(gbo, si);}
 
    size_t num_dofs(const ReferenceObjectID roid, const int si) const {return m_spDDI->num_dofs(roid, si);}
 
 
    size_t max_fct_dofs(const size_t fct, int dim) const {return m_spDDI->max_fct_dofs(fct, dim);}
 
    size_t max_fct_dofs(const size_t fct, const GridBaseObjectId gbo) const {return m_spDDI->max_fct_dofs(fct, gbo);}
 
    size_t max_fct_dofs(const size_t fct, const ReferenceObjectID roid) const {return m_spDDI->max_fct_dofs(fct, roid);}
 
    size_t max_fct_dofs(const size_t fct, const int dim, const int si) const {return m_spDDI->max_fct_dofs(fct, dim, si);}
 
    size_t max_fct_dofs(const size_t fct, const GridBaseObjectId gbo, const int si) const {return m_spDDI->max_fct_dofs(fct, gbo, si);}
 
    size_t num_fct_dofs(const size_t fct, const ReferenceObjectID roid, const int si) const {return m_spDDI->num_fct_dofs(fct, roid, si);}
 
 
    size_t offset(const ReferenceObjectID roid, const int si, const size_t fct) const {return m_spDDI->offset(roid,si,fct);}
 
 
    void print_local_dof_statistic() const {print_local_dof_statistic(1);}
 
    void print_local_dof_statistic(int verboseLev) const {m_spDDI->print_local_dof_statistic(verboseLev);}
 
  protected:
    ConstSmartPtr<DoFDistributionInfo> m_spDDI;
};
 
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__DOF_MANAGER__DOF_DISTRIBUTION_INFO__ */