base_space_member.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_MEMBER_H
#define BASE_SPACE_MEMBER_H

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

#ifndef TOTAL_POSET_MEMBER_H
#include "SheafSystem/total_poset_member.h"
#endif

#ifndef ARRAY_POSET_DOF_MAP_H
#include "SheafSystem/array_poset_dof_map.h"
#endif

#ifndef FIBER_BUNDLES_NAMESPACE_H
#include "SheafSystem/fiber_bundles_namespace.h"
#endif

#ifndef NAMESPACE_RELATIVE_MEMBER_INDEX_H
#include "SheafSystem/namespace_relative_member_index.h"
#endif

namespace sheaf
{
  class poset;
}

namespace fiber_bundle
{

class base_space_poset;

using namespace sheaf;


class SHEAF_DLL_SPEC base_space_member_row_dof_tuple_type
{
public:

  int db;

  int type_id;

  const char* type_name;

  int refinement_depth;

  int local_cell_type_id;

  const char* local_cell_type_name;

  size_type size;

  size_type i_size;

  size_type j_size;

  size_type k_size;

protected:

private:

};

 
class SHEAF_DLL_SPEC base_space_member : public total_poset_member
{

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

public:

  typedef fiber_bundles_namespace namespace_type;

  typedef base_space_poset host_type;

  static const poset_path& standard_schema_path();

  virtual const poset_path& schema_path() const;

  static void make_standard_schema(namespace_poset& xns);

  static const std::string& prototypes_poset_name();

  template <typename F>
  SHEAF_DLL_SPEC
  static bool standard_host_is_available(namespace_type& xns, const std::string& xhost_path, bool xauto_access);

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

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

protected:

private:



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

public:

  typedef base_space_member_row_dof_tuple_type row_dof_tuple_type;
  
  base_space_member();

  explicit base_space_member(const abstract_poset_member& xother,
                             bool xnew_jem = false,
                 bool xauto_access = true);

  virtual ~base_space_member();

  // NEW HANDLE, NEW STATE CONSTRUCTORS

  explicit base_space_member(poset* xhost,
                             array_poset_dof_map* xdof_map = 0,
                             bool xcopy_dof_map = false,
                             bool xauto_access = true);

  base_space_member(base_space_poset* xhost,
                    const std::string& xprototype_name,
                    bool xcopy_dof_map,
                    bool xauto_access);

  base_space_member(base_space_poset* xhost,
                    const std::string& xtype_name,
                    int xdb,
                    const std::string& xlocal_cell_name,
                    bool xauto_access);

  base_space_member(poset* xhost,
                    scoped_index* xexpansion,
                    int xexpansion_ct,
                    const tern& xnew_jem,
                    bool xauto_access);

  // NEW HANDLE, EXISTING STATE CONSTRUCTORS

  base_space_member(const poset* xhost, pod_index_type xhub_id);

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

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

  base_space_member(const namespace_poset* xnamespace, const poset_path& xpath, bool xauto_access);

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

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

  // EXISTING HANDLE, NEW STATE "CONSTRUCTORS" FACET

  // FEATURES:

  poset_path prototype_path() const;

  static poset_path prototype_path(const namespace_poset* xnamespace,
                                   const namespace_relative_member_index& xid);

  static bool prototype_exists(const std::string& xname, bool xauto_access);

  row_dof_tuple_type* row_dof_tuple(bool xrequire_write_access = false);

  static array_poset_dof_map* new_row_dof_map(const poset* xhost, const std::string& xprototype_name);

  static const scoped_index& new_row_dof_map(poset_state_handle& xhost,
                         const std::string& xprototype_name,
                         bool xauto_access = true);

protected:

private:



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

public:

  int db() const;

  const pod_index_type& type_id() const;

  const char* type_name() const;

  int refinement_depth() const;

  void put_refinement_depth(int xdepth);

  pod_index_type local_cell_type_id() const;

  const char* local_cell_type_name() const;

protected:

private:



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

public:

  void d_cells_ct(block<size_type>& xresult, bool xauto_access) const;

  base_space_member* c_not(bool xauto_access);

  void c_not_pa(base_space_member& result, bool xauto_access);

  base_space_member* c_minus(base_space_member& xother,
                             bool xnew_jem,
                             bool xauto_access);

  void c_minus(base_space_member& xother,
               base_space_member& result,
               bool xnew_jem,
               bool xauto_access);

protected:

private:



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

public:

protected:

private:



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

public:

  inline base_space_member* clone(bool xnew_state, bool xauto_access = true) const
  {
    return reinterpret_cast<base_space_member*>(total_poset_member::clone(xnew_state, xauto_access));
  }

protected:

private:



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

public:

  virtual array_poset_dof_map& dof_map(bool xrequire_write_access = false);

  virtual const array_poset_dof_map& dof_map(bool xrequire_write_access = false) const;

  virtual bool dof_map_is_ancestor_of(const poset_dof_map* xdof_map) const;

protected:

private:



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

public:

  inline base_space_member* greatest_jem() const
  {
    return reinterpret_cast<base_space_member*>(total_poset_member::greatest_jem());
  };

  inline base_space_member* least_jem() const
  {
    return reinterpret_cast<base_space_member*>(total_poset_member::least_jem());
  };

protected:

private:



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

public:

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

  inline base_space_member* p_meet(abstract_poset_member* other)
  {
    return reinterpret_cast<base_space_member*>(total_poset_member::p_meet(other));
  };

protected:

private:



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

public:

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

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

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

protected:

private:



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

public:


  //   ///
  //   /// The namespace of host()
  //   ///
  //   virtual fiber_bundles_namespace* name_space();

  //   ///
  //   /// True if other conforms to name_space().
  //   ///
  //   virtual bool namespace_is_ancestor_of(namespace_poset* other);

  //   ///
  //   /// The poset which this is a handle to a member of.
  //   ///
  //   virtual base_space_poset* host();

  poset* host() const;

  virtual bool host_is_ancestor_of(const poset_state_handle* other) const;

protected:

private:



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

public:

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

  virtual base_space_member* clone() const;

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

  base_space_member& operator=(const base_space_member& xother);

protected:

private:

};

} // namespace fiber_bundle

#endif // BASE_SPACE_MEMBER_H