section_space_schema_member_2.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 SECTION_SPACE_SCHEMA_MEMBER_H
#define SECTION_SPACE_SCHEMA_MEMBER_H

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

#ifndef SCOPED_INDEX_H
#include "SheafSystem/scoped_index.h"
#endif

#ifndef SCHEMA_POSET_MEMBER_H
#include "SheafSystem/schema_poset_member.h"
#endif

namespace sheaf
{
class cover_set_iterator;
}

namespace fiber_bundle
{

using namespace sheaf;

class sec_rep_descriptor;
class section_space_schema_poset;
class section_space_schema_jims_index_space_handle;


class SHEAF_DLL_SPEC section_space_schema_member : public schema_poset_member
{
  friend class section_space_schema_poset; // For access to get_ext_ids.

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

public:

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

  static const std::string& static_class_name();
  
  virtual section_space_schema_member& operator=(const abstract_poset_member& xother);

  section_space_schema_member& operator=(const section_space_schema_member& xother);

  virtual ~section_space_schema_member();

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

  // NEW HANDLE, NEW STATE CONSTRUCTORS

  // None - section_space_schema_member is abstract

  // NEW HANDLE, EXISTING STATE CONSTRUCTORS

  // None - section_space_schema_member is abstract

  // EXISTING HANDLE, NEW STATE "CONSTRUCTORS"

  // FEATURES:

  sec_rep_descriptor& rep();

  const sec_rep_descriptor& rep() const;

  bool same_rep(const section_space_schema_member& xother) const;

  pod_index_type base_space_id() const;

  void base_space_id(scoped_index& result) const;

  total_poset_member& base_space();

  const total_poset_member& base_space() const;

  bool same_base_space(const section_space_schema_member& xother) const;

  pod_index_type fiber_schema_id() const;

  void fiber_schema_id(scoped_index& result) const;

  schema_poset_member& fiber_schema();

  const schema_poset_member& fiber_schema() const;

  bool same_fiber_schema(const section_space_schema_member& xother) const;

  poset& fiber_space();

  const poset& fiber_space() const;

  int db() const;

  int df() const;

  int df(bool xauto_access);

  bool is_factorable() const;

  int evaluation_ct() const;

  int discretization_ct() const;

  subposet& discretization();

  const subposet& discretization() const;

  bool same_discretization(const section_space_schema_member& xother) const;

  subposet& evaluation();

  const subposet& evaluation() const;

  bool same_evaluation(const section_space_schema_member& xother) const;

  string evaluator_family_name() const;

  static string intersection_id_space_name(const subposet& xsp, const pod_index_type xindex);

  static string intersection_id_space_name(const subposet& xsp, const scoped_index& xindex);

//   ///
//   /// The number of bytes in this dof
//   ///
//   virtual size_t size() const = 0;

//   ///
//   /// The alignment for this dof
//   ///
//   virtual size_t alignment() const = 0;

//   ///
//   /// The primitive type index of the dof defined by this.
//   ///
//   virtual sheaf::primitive_type type() const = 0;

  virtual poset_dof_iterator* dof_iterator(bool xis_table_dofs,
                       int xversion = CURRENT_MEMBER_VERSION) const = 0;

  virtual bool conforms_to(const schema_poset_member& xother, bool xis_table_dofs) const;

protected:

  section_space_schema_member();

  virtual void attach_handle_data_members();

  pod_index_type _base_space_id;

  total_poset_member _base_space;

  pod_index_type _fiber_schema_id;

  schema_poset_member _fiber_schema;

  mutable int _db;

  mutable int _evaluation_ct;

  mutable int _discretization_ct;

private:



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

public:

//   ///
//   /// The type of table dofs (xis_table_dof == true) or
//   /// row dofs (xis_table_dof == false) defined by this schema.
//   /// Returns NOT_A_PRIMITIVE_TYPE if the dofs are
//   /// not all the same type.
//   ///
//   virtual primitive_type dof_tuple_type(bool xis_table_dof) const = 0;


  inline bool contains_dof(const schema_poset_member& xother, bool xin_table_dofs) const
  {
    return schema_poset_member::contains_dof(xother, xin_table_dofs);
  };

  inline bool contains_table_dof(const schema_poset_member& xother) const
  {
    return contains_dof(xother, true);
  };

  inline bool contains_row_dof(const schema_poset_member& xother) const
  {
    return contains_dof(xother, false);
  };

  inline bool contains_dof(pod_index_type xother_id, bool xin_table_dofs) const
  {
    return schema_poset_member::contains_dof(xother_id, xin_table_dofs);
  };

  inline bool contains_dof(const scoped_index& xother_id, bool xin_table_dofs) const
  {
    return schema_poset_member::contains_dof(xother_id, xin_table_dofs);
  };

  inline bool contains_table_dof(pod_index_type xother_id) const
  {
    return contains_dof(xother_id, true);
  };

  inline bool contains_table_dof(const scoped_index& xother_id) const
  {
    return contains_dof(xother_id, true);
  };

  inline bool contains_row_dof(pod_index_type xother_id) const
  {
    return contains_dof(xother_id, false);
  };

  inline bool contains_row_dof(const scoped_index& xother_id) const
  {
    return contains_dof(xother_id, false);
  };

  bool contains_dof(pod_index_type xbase_id,
            pod_index_type xfiber_id,
            bool xin_table_dofs) const;

  bool contains_dof(const scoped_index& xbase_id,
                    const scoped_index& xfiber_id,
                    bool xin_table_dofs) const;

  inline bool contains_table_dof(pod_index_type xbase_id,
                                 pod_index_type xfiber_id) const
  {
    return contains_dof(xbase_id, xfiber_id, true);
  };

  inline bool contains_table_dof(const scoped_index& xbase_id,
                                 const scoped_index& xfiber_id) const
  {
    return contains_dof(xbase_id, xfiber_id, true);
  };

  inline bool contains_row_dof(pod_index_type xbase_id,
                               pod_index_type xfiber_id) const
  {
    return contains_dof(xbase_id, xfiber_id, false);
  };

  inline bool contains_row_dof(const scoped_index& xbase_id,
                               const scoped_index& xfiber_id) const
  {
    return contains_dof(xbase_id, xfiber_id, false);
  };

//   ///
//   /// True if this is in the table dofs part (xin_table_dofs == true)
//   /// or in the row dofs part (xin_table_dofs == false) of some schema.
//   ///
//   virtual bool is_dof(bool xin_table_dofs) const = 0;

protected:

  virtual dof_descriptor_array* dof_descriptors(bool xis_table_dof) const = 0;

  virtual void update_table_dof_id_space() const;

  virtual void update_table_dof_descriptors() const;

private:



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

public:
 
  const index_space_handle& discretization_id_space() const;
 
  const index_space_handle& discretization_id_space(bool xauto_access) const;
 
  index_space_handle& discretization_id_space();
 
  index_space_handle& discretization_id_space(bool xauto_access);
 
  const index_space_handle& fiber_schema_id_space(bool xis_table_dofs) const;
 
  const index_space_handle& fiber_schema_id_space(bool xis_table_dofs, bool xauto_access) const;
  
  using schema_poset_member::size;
  
  virtual size_type size(pod_index_type xdof_id,
             bool xis_table_dof) const = 0;
 
  virtual size_type size(pod_index_type xdisc_id, 
             pod_index_type xfiber_dof_id, 
             bool xis_table_dof) const = 0;

  virtual size_type size(const scoped_index& xdisc_id,
             const scoped_index& xfiber_dof_id,
             bool xis_table_dof,
             bool xauto_access) const = 0;

  using schema_poset_member::alignment;

  virtual size_type alignment(pod_index_type xdof_id,
                  bool xis_table_dof) const = 0;

  virtual size_type alignment(pod_index_type xdisc_id,
                  pod_index_type xfiber_dof_id,
                  bool xis_table_dof) const = 0;

  virtual size_type alignment(const scoped_index& xdisc_id,
                  const scoped_index& xfiber_dof_id,
                  bool xis_table_dof,
                  bool xauto_access) const = 0;

  using schema_poset_member::type;

  virtual primitive_type type(pod_index_type xdof_id,
                  bool xis_table_dof) const = 0;

  virtual primitive_type type(pod_index_type xdisc_id,
                  pod_index_type xfiber_dof_id,
                  bool xis_table_dof) const = 0;

  virtual primitive_type type(const scoped_index& xdisc_id,
                  const scoped_index& xfiber_dof_id,
                  bool xis_table_dof, 
                  bool xauto_access) const = 0;

  using schema_poset_member::offset;

  virtual size_type offset(pod_index_type xdof_id,
               bool xis_table_dof) const = 0;

  virtual size_type offset(pod_index_type xdisc_id,
               pod_index_type xfiber_dof_id,
               bool xis_table_dof) const = 0;

  virtual size_type offset(const scoped_index& xdisc_id,
               const scoped_index& xfiber_dof_id,
               bool xis_table_dof, 
               bool xauto_access) const = 0;

  size_type fiber_size() const;

  size_type fiber_size(bool xauto_access) const;

  size_type component_size(pod_index_type xfiber_dof_id) const;

  size_type component_size(const scoped_index& xfiber_dof_id, bool xauto_access) const;

protected:
 
  mutable index_space_handle* _discretization_id_space;

private:



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

public:

  virtual pod_index_type get_ext_id(const std::string& xid_space_name) const;

protected:

private:



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

public:

//   ///
//   /// Prepare this for use as a schema.
//   /// @error host is immutable; remove this member.
//   ///
//   virtual void schematize();

  virtual schema_poset_member& unrestricted_schema();

  virtual const schema_poset_member& unrestricted_schema() const;

protected:

private:



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

public:

  // $$SCRIBBLE: Remove version hack.

//   ///
//   /// Sets version to (possibly aliased) xversion. If unalias == true,
//   /// set version to the actual version alias refers to.
//   ///
//   virtual void put_version(int xversion, bool xunalias = false);

protected:

private:



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

public:

  using schema_poset_member::attach_to_state;

  virtual void attach_to_state(pod_index_type xbase_space_id,
                               pod_index_type xfiber_schema_id);

  void attach_to_state(const scoped_index& xbase_space_id,
               const scoped_index& xfiber_schema_id);

  virtual void attach_to_state(const section_space_schema_poset* xhost,
                               pod_index_type xbase_space_id,
                               pod_index_type xfiber_schema_id);

  void attach_to_state(const section_space_schema_poset* xhost,
               const scoped_index& xbase_space_id,
               const scoped_index& xfiber_schema_id);

  virtual void attach_to_state(const section_space_schema_poset* xhost,
                               const poset_path& xbase_path,
                               const poset_path& xfiber_schema_path);

  virtual void detach_from_state();

protected:

private:



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

public:

  inline section_space_schema_poset* host() const
  {
    return reinterpret_cast<section_space_schema_poset*>(schema_poset_member::host());
  }

  virtual bool host_is_ancestor_of(const poset_state_handle* other) const;

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual section_space_schema_member* clone() const = 0;

  virtual bool invariant() const;

protected:

private:



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

public:

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

protected:

private:

};

// ===========================================================
// NONMEMBER FUNCTIONS
// ===========================================================

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC std::ostream& operator << (std::ostream &os, section_space_schema_member& p);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

} // namespace fiber_bundle

#endif // SECTION_SPACE_SCHEMA_MEMBER_H