base_space_poset.h

Go to the documentation of this file.

//
// 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.
//


#ifndef BASE_SPACE_POSET_H
#define BASE_SPACE_POSET_H

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

#ifndef REFINABLE_POSET_H
#include "SheafSystem/refinable_poset.h"
#endif

namespace sheaf
{
class namespace_poset;
}

namespace fiber_bundle
{

using namespace sheaf;  
  
class base_space_crg_interval;
class base_space_member_row_dof_tuple_type;
class base_space_poset;

// Following functions must be forward declared before friend statement.

SHEAF_DLL_SPEC
size_t deep_size(const base_space_poset& xp,
         bool xinclude_shallow = true,
         size_t xresults[4] = 0);

class SHEAF_DLL_SPEC base_space_poset_table_dof_tuple_type
{
public:

  int max_db;

protected:

private:

};  

class SHEAF_DLL_SPEC base_space_poset : public refinable_poset
{

  friend class sheaf::namespace_poset;
  friend class unstructured_block_builder;
  friend class fiber_bundles_namespace;
  friend SHEAF_DLL_SPEC size_t fiber_bundle::deep_size(const base_space_poset& xp, bool xinclude_shallow, size_t xresults[4]);
  
  // ===========================================================
  // ===========================================================

public:

  typedef base_space_poset_table_dof_tuple_type table_dof_tuple_type;

  typedef base_space_member_row_dof_tuple_type row_dof_tuple_type;

  static const poset_path& standard_schema_path();

  static base_space_poset& new_table(namespace_type& xhost, 
                     const poset_path& xpath, 
                     const poset_path& xschema_path,
                     int xmax_db,
                     bool xauto_access);
  
protected:

  base_space_poset();

  base_space_poset(const base_space_poset& xother) { };

  virtual ~base_space_poset();

private:

  static bool make_prototype();




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

public:

  bool contains_zone_id_space(pod_index_type xmbr_id, bool xauto_access) const;

  bool contains_zone_id_space(const scoped_index& xmbr_id, bool xauto_access) const;

  index_space_handle& get_zone_id_space(pod_index_type xmbr_id, bool xauto_access) const;


  index_space_handle& get_zone_id_space(const scoped_index& xmbr_id, bool xauto_access) const;

  void release_zone_id_space(index_space_handle& xid_space, bool xauto_access) const;

  index_space_iterator& get_zone_id_space_iterator(pod_index_type xmbr_id, bool xauto_access) const;

  index_space_iterator& get_zone_id_space_iterator(const scoped_index& xmbr_id, bool xauto_access) const;

  void release_zone_id_space_iterator(index_space_iterator& xitr, bool xauto_access) const;

protected:

private:



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

public:

  bool contains_vertex_id_space(pod_index_type xmbr_id, bool xauto_access) const;

  bool contains_vertex_id_space(const scoped_index& xmbr_id, bool xauto_access) const;

  index_space_handle& get_vertex_id_space(pod_index_type xmbr_id, bool xauto_access) const;

  index_space_handle& get_vertex_id_space(const scoped_index& xmbr_id, bool xauto_access) const;

  void release_vertex_id_space(index_space_handle& xid_space, bool xauto_access) const;

  index_space_iterator& get_vertex_id_space_iterator(pod_index_type xmbr_id, bool xauto_access) const;

  index_space_iterator& get_vertex_id_space_iterator(const scoped_index& xmbr_id, bool xauto_access) const;

  void release_vertex_id_space_iterator(index_space_iterator& xitr, bool xauto_access) const;

protected:

private:



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

public:

  bool contains_vertex_client_id_space(pod_index_type xmbr_id, bool xauto_access) const;

  bool contains_vertex_client_id_space(const scoped_index& xmbr_id, bool xauto_access) const;

  index_space_handle& get_vertex_client_id_space(pod_index_type xmbr_id, bool xauto_access) const;

  index_space_handle& get_vertex_client_id_space(const scoped_index& xmbr_id, bool xauto_access) const;

  void release_vertex_client_id_space(index_space_handle& xid_space, bool xauto_access) const;

  index_space_iterator& get_vertex_client_id_space_iterator(pod_index_type xmbr_id, bool xauto_access) const;

  index_space_iterator& get_vertex_client_id_space_iterator(const scoped_index& xmbr_id, bool xauto_access) const;

  void release_vertex_client_id_space_iterator(index_space_iterator& xitr, bool xauto_access) const;

protected:

private:



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

public:

  bool contains_connectivity_id_space(pod_index_type xzone_id, bool xauto_access) const;

  bool contains_connectivity_id_space(const scoped_index& xzone_id, bool xauto_access) const;

  index_space_handle& get_connectivity_id_space(pod_index_type xzone_id, bool xauto_access) const;

  index_space_handle& get_connectivity_id_space(const scoped_index& xzone_id, bool xauto_access) const;

  void release_connectivity_id_space(index_space_handle& xid_space, bool xauto_access) const;

  index_space_iterator& get_connectivity_id_space_iterator(pod_index_type xzone_id, bool xauto_access) const;

  index_space_iterator& get_connectivity_id_space_iterator(const scoped_index& xzone_id, bool xauto_access) const;

  void release_connectivity_id_space_iterator(index_space_iterator& xid_space, bool xauto_access) const;

protected:

private:



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

public:

  bool contains_adjacency_id_space(pod_index_type xvertex_id, bool xauto_access) const;

  bool contains_adjacency_id_space(const scoped_index& xvertex_id, bool xauto_access) const;

  index_space_handle& get_adjacency_id_space(pod_index_type xvertex_id, bool xauto_access) const;

  index_space_handle& get_adjacency_id_space(const scoped_index& xvertex_id, bool xauto_access) const;

  void release_adjacency_id_space(index_space_handle& xid_space, bool xauto_access) const;

  index_space_iterator& get_adjacency_id_space_iterator(pod_index_type xvertex_id, bool xauto_access) const;

  index_space_iterator& get_adjacency_id_space_iterator(const scoped_index& xvertex_id, bool xauto_access) const;

  void release_adjacency_id_space_iterator(index_space_iterator& xid_space, bool xauto_access) const;

protected:

private:




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

public:

  static const std::string& prototypes_poset_name();

  pod_index_type prototype_type_id(const std::string& xname, bool xauto_access = true) const;

  scoped_index prototype_dof_tuple_id(const std::string& xname,
                      int xdepth,
                      bool xcreate,
                      bool xauto_access) const;

protected:

private:



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

public:

protected:

private:



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

public:

  virtual poset_type type_id() const;

  virtual const char* class_name() const;

protected:

  virtual void attach_handle_data_members();

private:


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

public:

  using refinable_poset::new_member;
  
  pod_index_type new_member(const std::string& xprototype_name, bool xcopy_dof_map);
  
  pod_index_type new_member(const char* xprototype_name, bool xcopy_dof_map);

  pod_index_type new_member(const std::string& xtype_name, int xdb, const std::string& xlocal_cell_name);
  
protected:

private:


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

public:

  subposet& blocks();

  const subposet& blocks() const;

  static std::string blocks_name();

  subposet& block_vertices();

  const subposet& block_vertices() const;

  static std::string block_vertices_name();

  subposet& vertices();

  const subposet& vertices() const;

  subposet& elements();

  const subposet& elements() const;

  subposet& d_cells(int xd);

  const subposet& d_cells(int xd) const;

  scattered_insertion_index_space_handle& d_cells_id_space(int xd);

  const scattered_insertion_index_space_handle& d_cells_id_space(int xd) const;

  static std::string d_cells_name(int xdb, int xmax_db);

  subposet& cells();

  const subposet& cells() const;

  static std::string cells_name();

  void insert_interval_in_standard_subposets(base_space_crg_interval& xinterval);

protected:

  subposet _blocks;

  subposet _block_vertices;

  block<subposet> _d_cells;

  block<scattered_insertion_index_space_handle*> _d_cells_id_spaces;

  subposet _cells;

  virtual void initialize_standard_subposets(const std::string& xname);

private:

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

public:

  int max_db() const;

  void put_max_db(int xmax_db);

  void update_max_db(int xmax_db);

  const table_dof_tuple_type* table_dof_tuple() const;

  table_dof_tuple_type* table_dof_tuple();

protected:

private:


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

public:

  int db(pod_index_type xmbr_hub_id) const;

  int db(const scoped_index& xmbr_id) const;

  pod_index_type type_id(pod_index_type xmbr_hub_id) const;

  pod_index_type type_id(const scoped_index& xmbr_id) const;

  std::string type_name(pod_index_type xmbr_hub_id) const;

  std::string type_name(const scoped_index& xmbr_id) const;

  int refinement_depth(pod_index_type xmbr_hub_id) const;

  int refinement_depth(const scoped_index& xmbr_id) const;

  void put_refinement_depth(pod_index_type xmbr_hub_id, int xdepth);

  void put_refinement_depth(const scoped_index& xmbr_id, int xdepth);

  using refinable_poset::member_dof_tuple;
  
  row_dof_tuple_type* member_dof_tuple(pod_index_type xmbr_hub_id,
                                       bool xrequire_write_access = false) const;

  row_dof_tuple_type* member_dof_tuple(const scoped_index& xmbr_id,
                                       bool xrequire_write_access = false) const;

  row_dof_tuple_type* row_dof_tuple(pod_index_type xtuple_hub_id,
                                    bool xrequire_write_access = false) const;

  row_dof_tuple_type* row_dof_tuple(const scoped_index& xtuple_id,
                                    bool xrequire_write_access = false) const;

  using refinable_poset::new_row_dof_map;

  const scoped_index& new_row_dof_map(const std::string& xprototype_name);

protected:

private:


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

public:

  bool is_explicit_member(pod_index_type xmbr_id) const;
  
  bool is_block_member(pod_index_type xmbr_id) const;
  
protected:

private:



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

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual bool invariant() const;

protected:

  virtual base_space_poset* clone() const;

  base_space_poset& operator=(const poset_state_handle& xother)
  {
    return const_cast<base_space_poset&>(*this);
  };

private:

};

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



} // namespace fiber_bundle


#endif // BASE_SPACE_POSET_H