structured_block_2d.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 STRUCTURED_Block_2d

#ifndef STRUCTURED_BLOCK_2D_H
#define STRUCTURED_BLOCK_2D_H

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

#ifndef STRUCTURED_BLOCK_H
#include "SheafSystem/structured_block.h"
#endif

#ifndef STRUCTURED_BLOCK_2D_CRG_INTERVAL_H
#include "SheafSystem/structured_block_2d_crg_interval.h"
#endif

#ifndef CHART_POINT_2D_H
#include "SheafSystem/chart_point_2d.h"
#endif

namespace fiber_bundle
{

using namespace sheaf;

class SHEAF_DLL_SPEC structured_block_2d : public structured_block
{

  friend class structured_block_2d_crg_interval;

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

public:

  static const poset_path& static_prototype_path();

  static host_type& new_host(namespace_type& xns, 
                 const poset_path& xhost_path, 
                 const poset_path& xschema_path, 
                 bool xauto_access);

  static host_type& standard_host(namespace_type& xns, const poset_path& xhost_path, bool xauto_access);

protected:

private:



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

public:

  structured_block_2d();

  explicit structured_block_2d(const abstract_poset_member& xother,
                               bool xnew_jem = false);

  virtual ~structured_block_2d();

  // NEW HANDLE, NEW STATE CONSTRUCTORS:

  structured_block_2d(poset* xhost,
                      const size_type& xi_size,
                      const size_type& xj_size,
                      bool xauto_access);

  // NEW HANDLE, EXISTING STATE CONSTRUCTORS:

  structured_block_2d(const poset* xhost, pod_index_type xhub_id);

  structured_block_2d(const poset* xhost, const scoped_index& xid);

  structured_block_2d(const poset* xhost, const std::string& xname);

  structured_block_2d(const namespace_poset* xnamespace,
                      const poset_path& xpath,
                      bool xauto_access = true);

  structured_block_2d(const namespace_poset* xnamespace,
                      pod_index_type xposet_id,
                      pod_index_type xmember_id);

  structured_block_2d(const namespace_poset* xnamespace,
                      const scoped_index& xposet_id,
                      const scoped_index& xmember_id);


  // EXISTING HANDLE, NEW STATE "CONSTRUCTORS":

  void new_state(const size_type& xi_size, const size_type& xj_size,
                 bool xauto_access = true);

  void new_state(poset* xhost, const size_type& xi_size,
                 const size_type& xj_size, bool xauto_access = true);

  // FEATURES:

  enum static_const_int {DB = 2};

  size_type i_size() const;

  size_type j_size() const;

protected:

//   ///
//   /// The type of row dof tuple for this.
//   ///
//   struct SHEAF_DLL_SPEC row_dof_tuple_type
//   {
//     ///
//     /// The base space dimension.
//     ///
//     int db;

//     ///
//     /// The cell type id.
//     ///
//     int type_id;

//     ///
//     /// The cell type name.
//     ///
//     const char* type_name;

//     ///
//     /// The refinement depth.
//     ///
//     int refinement_depth;

//     ///
//     /// The local cell type id.
//     ///
//     int local_cell_type_id;

//     ///
//     /// The local cell type name.
//     ///
//     const char * local_cell_type_name;

//     ///
//     /// The number of local cell instances in this block.
//     ///
//     size_type size;

//     ///
//     /// The upper bound for index 0.
//     ///
//     size_type i_size;

//     ///
//     /// The upper bound for index 1.
//     ///
//     size_type j_size;
//   };


//   ///
//   /// The row dof tuple for this.
//   ///
//   inline row_dof_tuple_type* row_dof_tuple()
//   {
//     return reinterpret_cast<row_dof_tuple_type*>(dof_map().dof_tuple());
//   };

  using structured_block::new_row_dof_map;

  static scoped_index
  new_row_dof_map(poset_state_handle& xhost,
                  size_type xi_size,
                  size_type xj_size,
                  bool xauto_access);


private:

  inline pod_index_type offset(pod_index_type i, pod_index_type j) const
  {
    return (i *= j_size()) += j;
  };



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

public:

protected:

private:



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

public:

  chart_point_2d* refine_point(const chart_point& xpt) const
  {
    return reinterpret_cast<chart_point_2d*>(structured_block::refine_point(xpt));
  };

  virtual void refine_point_pa(const chart_point& xpt, chart_point& result) const;

  virtual void refine_point_pa(const chart_point& xpt,
                               block<chart_point_3d>& result) const;

  chart_point_2d* unrefine_point(const chart_point& xpt) const
  {
    return reinterpret_cast<chart_point_2d*>(structured_block::unrefine_point(xpt));
  };

  virtual void unrefine_point_pa(const chart_point& xpt, chart_point& result) const;

  virtual void refine();

  virtual void unrefine();

  virtual void simplify();

  virtual void unsimplify();

protected:

private:



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

public:

  static const poset_path& static_local_cell_prototype_path();

protected:

  virtual const structured_block_2d_crg_interval& interval() const;

private:



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

public:

protected:

private:



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

public:

protected:

private:



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

public:

  virtual structured_block_2d* clone() const;

  inline structured_block_2d* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<structured_block_2d*>(structured_block::clone(xnew_state, xauto_access));
  };

protected:

private:



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

public:

  inline structured_block_2d* greatest_jem() const
  {
    return static_cast<structured_block_2d*>(base_space_member::greatest_jem());
  };

  inline structured_block_2d* least_jem() const
  {
    return static_cast<structured_block_2d*>(base_space_member::least_jem());
  };

protected:

private:



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

public:

  inline structured_block_2d* p_join(abstract_poset_member* other) const
  {
    return static_cast<structured_block_2d*>(base_space_member::p_join(other));
  };

  inline structured_block_2d* p_meet(abstract_poset_member* other)
  {
    return static_cast<structured_block_2d*>(base_space_member::p_meet(other));
  };

protected:

private:



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

public:

  inline structured_block_2d* l_join(abstract_poset_member* other, bool xnew_jem = true)
  {
    return static_cast<structured_block_2d*>(base_space_member::l_join(other, xnew_jem));
  };

  inline structured_block_2d* l_meet(abstract_poset_member* other, bool xnew_jem = true)
  {
    return static_cast<structured_block_2d*>(base_space_member::l_meet(other, xnew_jem));
  };

  inline structured_block_2d* l_not(bool xnew_jem = true) const
  {
    return static_cast<structured_block_2d*>(base_space_member::l_not(xnew_jem));
  };

protected:

private:



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

public:

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

  virtual structured_block_2d& operator=(const abstract_poset_member& xother);

  structured_block_2d& operator=(const structured_block_2d& xother);

protected:

private:

};
  
} // namespace fiber_bundle

#endif // STRUCTURED_BLOCK_2D_H