section_dof_map.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 section_dof_map;
// map from sec_rep_space client dof id to dof value

#ifndef SECTION_DOF_MAP_H
#define SECTION_DOF_MAP_H

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

#ifndef POSET_DOF_MAP_H
#include "SheafSystem/poset_dof_map.h"
#endif

#ifndef SEC_REP_SPACE_H
#include "SheafSystem/sec_rep_space.h"
#endif

namespace sheaf
{
class poset_state_handle;
}

namespace fiber_bundle
{

using namespace sheaf;


class SHEAF_DLL_SPEC section_dof_map : public poset_dof_map
{
  friend class sec_rep_space_member;

public:

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

  static const std::string& static_class_name();

  // CANONICAL MEMBERS

  section_dof_map& operator=(const section_dof_map& xother);

  virtual ~section_dof_map();

  virtual bool invariant() const;

  // MAP INTERFACE

  virtual sec_rep_space* host() const;

  virtual section_space_schema_member& schema();

  virtual const section_space_schema_member& schema() const;
  
  using poset_dof_map::get_dof;
  using poset_dof_map::put_dof;

  // ===========================================================
  //  NEW DOF ACCESS FACET
  // ===========================================================


  virtual bool dof_in_bounds(pod_index_type xdof_id, bool xis_table_dofs) const;

  virtual bool dof_in_bounds(pod_index_type xdisc_id, pod_index_type xfiber_id, bool xis_table_dofs) const;
 
  virtual void get_dof(pod_index_type xdisc_id, 
               pod_index_type xfiber_dof_id, 
               void* xdof, 
               size_type xdof_size) const = 0;


  void get_dof(pod_index_type xdisc_id, 
           pod_index_type xfiber_dof_id, 
           void* xdof, 
           size_type xdof_size)
  {
    const section_dof_map* lthis = this;
    lthis->get_dof(xdisc_id, xfiber_dof_id, xdof, xdof_size);
  };
 
  void get_dof(const scoped_index& xdisc_id, 
           const scoped_index& 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)
  {
    const section_dof_map* lthis = this;
    lthis->get_dof(xdisc_id, xfiber_dof_id, xdof, xdof_size);
  };

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

  void put_dof(const scoped_index& xdisc_id, 
           const scoped_index& xfiber_dof_id, 
           const void* xdof, 
           size_type xdof_size);

  virtual bool fiber_in_bounds(pod_index_type xdisc_id, bool xis_table_dofs) const;
 
  virtual 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) const;

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

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

  virtual 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);
 
  virtual void get_component(pod_index_type xfiber_dof_id, void* xcomponent, size_type xcomponent_size) const = 0;

  void get_component(const scoped_index& xfiber_dof_id, void* xcomponent, size_type xcomponent_size) const;

  virtual void put_component(pod_index_type xfiber_dof_id, const void* xcomponent, size_type xcomponent_size) = 0;

  void put_component(const scoped_index& xfiber_dof_id, const void* xcomponent, size_type xcomponent_size);
  
  
  
  // ===========================================================
  //  END NEW DOF ACCESS FACET
  // ===========================================================

  // ===========================================================
  // I/O SUPPORT FACET
  // ===========================================================

  virtual bool supports_xfr_opt() const;

protected:

  // CANONICAL MEMBERS

  section_dof_map();

  section_dof_map(const section_dof_map& xother);

  // MAP INTERFACE

  section_dof_map(sec_rep_space* xhost,
                  pod_index_type xbase_id,
                  int xversion);

private:


};

} // namespace fiber_bundle

#endif // ifndef SECTION_DOF_MAP_H