block_adjacency.h

//
// Copyright (c) 2014 Limit Point Systems, Inc. 
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class block_adjacency

#ifndef BLOCK_ADJACENCY_H
#define BLOCK_ADJACENCY_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef BLOCK_RELATION_H
#include "SheafSystem/block_relation.h"
#endif

#ifndef STD_MAP_H
#include "SheafSystem/std_map.h"
#endif

#ifndef SINGLY_LINKED_LIST_H
#include "SheafSystem/singly_linked_list.h"
#endif

namespace fiber_bundle
{

  class block_connectivity;
  using namespace sheaf;

class SHEAF_DLL_SPEC block_adjacency : public block_relation
{

  // ===========================================================
  // BLOCK_ADJACENCY FACET
  // ===========================================================

public:

  typedef std::map< pod_index_type, singly_linked_list<pod_index_type> > adj_type;

  typedef adj_type::iterator node_iterator_type;

  typedef adj_type::const_iterator const_node_iterator_type;

  typedef adj_type::mapped_type::iterator zone_iterator_type;

  typedef adj_type::mapped_type::const_iterator const_zone_iterator_type;


  block_adjacency();

  block_adjacency(const block_adjacency& xother);

  block_adjacency(const block_connectivity& xconn);

  block_adjacency(size_type xzone_ct,
                  size_type xnodes_per_zone,
                  size_type xnode_ids_ct,
                  const pod_index_type* xnode_ids,
                  cell_type xelement_type = CELL_TYPE_END);

  virtual ~block_adjacency();

  void put_connectivity(const block_connectivity& xconn);

  void put_connectivity(size_type xzone_ct,
                        size_type xnodes_per_zone,
                        size_type xnode_ids_ct,
                        const pod_index_type* xnode_ids);

  block_adjacency& operator=(const block_connectivity& xconn);

  node_iterator_type begin();

  const_node_iterator_type begin() const;

  node_iterator_type end();

  const_node_iterator_type end() const;

  size_type node_ct() const;

  size_type zone_ct() const;


protected:

  adj_type _adj;

  size_type _node_ct;

  size_type _zone_ct;


private:

  // ===========================================================
  // BLOCK_RELATION FACET
  // ===========================================================

public:

  virtual cell_type element_type() const;

protected:

  cell_type _element_type;

private:


  // ===========================================================
  // ANY FACET
  // ===========================================================

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual block_adjacency* clone() const;

  block_adjacency& operator=(const block_adjacency& xother);

  virtual bool invariant() const;

protected:
private:

};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC 
std::ostream& operator<<(std::ostream& xos, const block_adjacency& xconn);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

} // namespace fiber_bundle
 

#endif // ifndef BLOCK_ADJACENCY_H