Commit 60b842cd authored by Dennis Gläser's avatar Dennis Gläser
Browse files

[entitynetwork] add contained entity network interface

parent d72b07eb
install(FILES
constraints.hh
containedentitynetworkinterface.hh
entitynetworkinterface.hh
impl_admissibledimension.hh
impl_admissiblemagnitude.hh
......
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*****************************************************************************
* See the file COPYING for full copying permissions. *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 2 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 General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file
* \brief Interface defining networks of entities contained
* in (possibly multiple) sub-domains.
*/
#ifndef FRACKIT_CONTAINED_ENTITY_NETWORK_INTERFACE_HH
#define FRACKIT_CONTAINED_ENTITY_NETWORK_INTERFACE_HH
#include <vector>
#include <TopTools_DataMapOfShapeInteger.hxx>
#include <TopTools_ListOfShape.hxx>
#include <TopoDS_Shape.hxx>
namespace Frackit {
/*!
* \brief Interface defining networks of entities contained
* in (possibly multiple) sub-domains.
*/
class ContainedEntityNetworkInterface
{
public:
/*!
* \brief Constructor.
* \param entityDim Dimension of the network entities
* \param domainDim Dimension of the domain in
* which entities are embedded
*/
ContainedEntityNetworkInterface(int entityDim, int domainDim)
: entityDimension_(entityDim)
, domainDimension_(domainDim)
{}
/*!
* \brief Returns the dimension of the network entities.
*/
int entityDimension() const
{ return entityDimension_; }
/*!
* \brief Returns the dimension of the (sub-)domains.
*/
int domainDimension() const
{ return domainDimension_; }
/*!
* \brief Returns the indices of defined the sub-domains
*/
virtual const std::vector<std::size_t>& subDomainIndices() const = 0;
/*!
* \brief Returns the fragments of a sub-domain
* \param subDomainIdx The index of the sub-domain
*/
virtual const TopTools_ListOfShape& subDomainFragments(std::size_t subDomainIdx) const = 0;
/*!
* \brief Returns the entity fragments of the network defined for a sub-domain
* \param subDomainIdx The index of the sub-domain
*/
virtual const TopTools_ListOfShape& subDomainEntityFragments(std::size_t subDomainIdx) const = 0;
/*!
* \brief Returns the map which maps each fragment the network of a sub-domain to its primary entity index.
* \param subDomainIdx The index of the sub-domain
*/
virtual const TopTools_DataMapOfShapeInteger& subDomainEntityFragmentsIndexMap(std::size_t subDomainIdx) const = 0;
private:
int entityDimension_;
int domainDimension_;
};
} // end namespace Frackit
#endif // FRACKIT_CONTAINED_ENTITY_NETWORK_INTERFACE_HH
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment