sec_rep_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 SEC_REP_SPACE_MEMBER_H
#define SEC_REP_SPACE_MEMBER_H

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

#ifndef POSET_MEMBER_H
#include "SheafSystem/poset_member.h"
#endif

#ifndef FIBER_BUNDLE_H
#include "SheafSystem/fiber_bundle.h"
#endif
 
#ifndef SECTION_DOF_MAP_H
#include "SheafSystem/section_dof_map.h"
#endif

#ifndef SECTION_SPACE_SCHEMA_MEMBER_H
#include "SheafSystem/section_space_schema_member.h"
#endif

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

namespace sheaf
{
class scattered_insertion_index_space_handle;
class index_space_handle;
class index_space_iterator;
class poset_dof_map;
}

namespace fiber_bundle
{

using namespace sheaf;
class sec_rep_space;
class binary_section_space_schema_member;
class binary_section_space_schema_poset;

class SHEAF_DLL_SPEC sec_rep_space_member : public poset_member
{
  // ===========================================================
  // ===========================================================

public:

  // Typedefs:

  typedef binary_section_space_schema_member schema_type;

  typedef binary_section_space_schema_poset schema_host_type;

  virtual const std::string& class_name() const;

  static const std::string& static_class_name();
  
  static std::string standard_schema_poset_name(const std::string& xschema_member_name);

  static std::string standard_fiber_space_name(const poset_path& xschema_path);

  static std::string standard_section_space_name(const std::string& xfiber_space_name,
                         const std::string& xbase_space_name);

  sec_rep_space_member();

  sec_rep_space_member(const sec_rep_space_member& xother,
                       bool xnew_jem = false);

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

  sec_rep_space_member& operator=(const sec_rep_space_member& xother);

  ~sec_rep_space_member();

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


  // NEW HANDLE, NEW STATE CONSTRUCTORS

  explicit sec_rep_space_member(sec_rep_space* xhost,
                                section_dof_map* xdof_map = 0,
                                bool xauto_access = true);

  sec_rep_space_member(sec_rep_space* xhost,
                       abstract_poset_member& xbase_mbr,
                       int xbase_version = CURRENT_HOST_VERSION,
                       bool xauto_access = true);

  sec_rep_space_member(sec_rep_space* xhost, const subposet& xbase_parts, bool xauto_access);

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


  // NEW HANDLE, EXISTING STATE CONSTRUCTORS

  sec_rep_space_member(const sec_rep_space* xhost, pod_index_type xindex);

  sec_rep_space_member(const sec_rep_space* xhost, const scoped_index& xindex);

  sec_rep_space_member(const sec_rep_space* xhost, const std::string& xname);

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

  sec_rep_space_member(const namespace_poset* xnamespace,
                       pod_index_type xposet_index,
                       pod_index_type  xmember_index);

  sec_rep_space_member(const namespace_poset* xnamespace,
                       const scoped_index& xposet_index,
                       const scoped_index&  xmember_index);

  explicit sec_rep_space_member(const sec_rep_space_member* xother);


  // EXISTING HANDLE, NEW STATE "CONSTRUCTORS"

  using poset_member::new_jim_state;

  void new_jim_state(abstract_poset_member& xbase_mbr,
                     int xbase_version = CURRENT_HOST_VERSION,
                     bool xauto_access = true);

  void new_jim_state(sec_rep_space* xhost,
                     const abstract_poset_member& xbase_mbr,
                     int xbase_version = CURRENT_HOST_VERSION,
                     bool xauto_access = true);

  using poset_member::new_jrm_state;

  void new_jrm_state(sec_rep_space* xhost, const subposet& xbase_parts, bool xauto_access);

protected:

private:



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

public:

  bool is_multisection(bool xauto_access) const;

  bool has_branch_id_space(bool xauto_access) const;

  scattered_insertion_index_space_handle& get_branch_id_space(bool xauto_access);

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

  bool allocated_branch_handle(index_space_handle& xid_space, bool xauto_access) const;

  index_space_iterator& get_branch_id_space_iterator(bool xauto_access) const;

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

  bool allocated_branch_iterator(index_space_iterator& xitr, bool xauto_access) const;

protected:

private:



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

public:

  using poset_member::schema;

  virtual section_space_schema_member& schema();

  virtual const section_space_schema_member& schema() const;

  section_space_schema_member& schema(bool xauto_access);

  const section_space_schema_member& schema(bool xauto_access) const;

  virtual section_space_schema_member& unrestricted_schema();
  
  virtual const section_space_schema_member& unrestricted_schema() const;

protected:

private:



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

public:

  abstract_poset_member& base();

  const abstract_poset_member& base() const;

  bool same_base(const sec_rep_space_member* xother) const;



  virtual int db() const;

  bool same_rep(const sec_rep_space_member* xother) const;

  int discretization_ct() const;

  //  (version with access control).
  int discretization_ct(bool xaxto_access) const;

  int evaluation_ct() const;

  schema_poset_member& fiber_schema();

  const schema_poset_member& fiber_schema() const;

  poset& fiber();

  const poset& fiber() const;

  int df() const;

  using poset_member::restrict_to;

  virtual void restrict_to(pod_index_type xbase_id, pod_index_type xfiber_schema_id);

  void restrict_to(const scoped_index& xbase_id, const scoped_index& xfiber_schema_id);

  virtual void restrict_to(const abstract_poset_member* xbase, const abstract_poset_member* xfiber_schema);

  bool base_is_restricted() const;

  bool fiber_schema_is_restricted() const;

  int version() const;

protected:

private:



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

public:

  using poset_member::get_dof;

  virtual void get_dof(pod_index_type xdisc_id, 
               pod_index_type xfiber_dof_id, 
               void* xdof, 
               size_type xdof_size) const;
 
  void get_dof(const scoped_index& xdisc_id, 
           const scoped_index& xfiber_dof_id, 
           void* xdof, 
           size_type xdof_size,
           bool xauto_access) const;

  using poset_member::put_dof;

  virtual void put_dof(pod_index_type xdisc_id, 
               pod_index_type xfiber_dof_id, 
               const void* xdof, 
               size_type xdof_size);

  void put_dof(const scoped_index& xdisc_id, 
           const scoped_index& xfiber_dof_id, 
           const void* xdof, 
           size_type xdof_size,
           bool xauto_access);
 
  void get_fiber(pod_index_type xdisc_id, void* xfiber, size_type xfiber_size) const;

  void get_fiber(const scoped_index& xdisc_id, void* xfiber, size_type xfiber_size, bool xauto_access) const;

  void put_fiber(pod_index_type xdisc_id, const void* xfiber, size_type xfiber_size);

  void put_fiber(const scoped_index& xdisc_id, const void* xfiber, size_type xfiber_size, bool xauto_access);

  void force_fiber(pod_index_type xdisc_id, const void* xfiber, size_type xfiber_size);

  void force_fiber(const scoped_index& xdisc_id, const void* xfiber, size_type xfiber_size, bool xauto_access);
 
  void get_component(pod_index_type xfiber_dof_id, void* xcomponent, size_type xcomponent_size) const;

  void get_component(const scoped_index& xfiber_dof_id, 
             void* xcomponent, 
             size_type xcomponent_size, 
             bool xauto_access) const;
 
  void put_component(pod_index_type xfiber_dof_id, const void* xcomponent, size_type xcomponent_size);

  void put_component(const scoped_index& xfiber_dof_id, 
             const void* xcomponent, 
             size_type xcomponent_size,
             bool xauto_access);

protected:

private:



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

public:

  size_t dof_tuple_size();

  size_t fiber_size();

  virtual section_dof_map& dof_map(bool xrequire_write_access = false);

  virtual const section_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:

  sec_rep_space* host() const;

  virtual bool host_is_ancestor_of(const poset_state_handle* xother) const;

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual sec_rep_space_member* clone() const;

  bool invariant() const;

protected:

private:

};

} // namespace fiber_bundle

#endif // ifndef SEC_REP_SPACE_MEMBER_H