block_connectivity.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_connectivity

#ifndef BLOCK_CONNECTIVITY_H
#define BLOCK_CONNECTIVITY_H

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

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

#ifndef POD_TYPES_H
#include "SheafSystem/pod_types.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

namespace fiber_bundle
{
  
  using namespace sheaf;

class SHEAF_DLL_SPEC block_connectivity  : public block_relation
{
public:

  // ===========================================================
  // ===========================================================

public:

  virtual ~block_connectivity();

  size_type element_ct() const;

  size_type node_ct() const;

  pod_index_type* node_ids();

  const pod_index_type* node_ids() const;

  bool delete_node_ids() const;

  size_type node_id_ct() const;

  size_type nodes_per_element() const;

  pod_index_type start_id() const;

  virtual void to_stream(std::ostream& xos) const;

  block_connectivity& operator=(const block_connectivity& xother);

  virtual bool operator==(const block_connectivity& xother) const;

protected:

  block_connectivity();

  block_connectivity(const block_connectivity& xother);

  block_connectivity(const pod_index_type* xnode_ids, 
             size_type xnode_id_ct,
             size_type xnodes_per_element,
             size_type xnode_ct);

  //*/
  block_connectivity(pod_index_type xstart_id);

  size_type _element_ct;

  size_type _node_ct;

  size_type _node_id_ct;

  pod_index_type* _node_ids;

  bool _delete_node_ids;

  size_type _nodes_per_element;

  pod_index_type _start_id;

private:


  // ===========================================================
  // ===========================================================

public:

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  virtual block_connectivity* clone() const = 0;

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

protected:

private:

};


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

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

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

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

} // namespace fiber_bundle

#endif // ifndef BLOCK_CONNECTIVITY_H