array_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 array_section_dof_map;
// map from client dof id to dof value.
// The section_dof_map interface assumes dofs
// are indexed by (base id, fiber id) pairs.
// This representation uses contiguous storage with
// the fiber index varying most rapidly

#ifndef ARRAY_SECTION_DOF_MAP_H
#define ARRAY_SECTION_DOF_MAP_H

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

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

namespace fiber_bundle
{

class sec_rep_space;

class SHEAF_DLL_SPEC array_section_dof_map : public section_dof_map
{

  friend class fiber_bundles_namespace;

public:

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

  static const std::string& static_class_name();

  // ===========================================================
  // CANONICAL FACET
  // ===========================================================

  array_section_dof_map();

  virtual array_section_dof_map* clone() const;

  array_section_dof_map(const array_section_dof_map& xother);

  virtual array_section_dof_map* copy() const;

  array_section_dof_map& operator=(const array_section_dof_map& xother);

  virtual ~array_section_dof_map();

  virtual bool invariant() const;

  // ===========================================================
  // MAP FACET
  // ===========================================================

  array_section_dof_map(sec_rep_space* xhost, void* xdofs = 0, size_t xdofs_ub = 0);

  array_section_dof_map(sec_rep_space* xhost,
                        pod_index_type xbase_id,
                        int xversion,
                        void* xdofs = 0,
                        size_t xdofs_ub = 0);

  array_section_dof_map(sec_rep_space* xhost,
                        const scoped_index& xbase_id,
                        int xversion,
                        void* xdofs = 0,
                        size_t xdofs_ub = 0);  

  virtual dof_tuple_type type_id() const
  {
    return ARRAY_SECTION_DOF_TUPLE_ID;
  };

  using section_dof_map::get_dof;
  using section_dof_map::put_dof;

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

public:

  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 xdof_id, void* xdof, size_type xdof_size) const;

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

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

  virtual void put_dof(pod_index_type xdisc_id, 
               pod_index_type 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;

  void reserve_fiber(pod_index_type xdisc_id);
 
  virtual void get_fiber(pod_index_type 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);

  virtual void force_fiber(pod_index_type 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;

  virtual void put_component(pod_index_type xfiber_dof_id, const void* xcomponent, size_type xcomponent_size);
  
protected:

private:

  void* dof_ptr(pod_index_type xdof_id, bool xis_table_dofs) const
  {
    return _dofs + schema().offset(xdof_id, xis_table_dofs);
  }

  void* dof_ptr(pod_index_type xdisc_id, pod_index_type xfiber_dof_id, bool xis_table_dofs) const
  {
    return _dofs + schema().offset(xdisc_id, xfiber_dof_id, xis_table_dofs);
  }
  
    
 
public:

  virtual void* dof_tuple();

  virtual const void* dof_tuple() const;

  virtual void get_dof_tuple(void* xbuf, size_t xbuflen) const;

  virtual void put_dof_tuple(const void* xbuf, size_t xbuflen);


protected:

  virtual void allocate_dofs();

private:

  int _fiber_dof_ct;

  int _local_ct;

  
  // Needed for fiber_bundle::array_section_dof_map::copy_dof(const scoped_index&, const scoped_index&,
  //                                                          const scoped_index&, bool, void*, size_t, bool) const

  mutable dof_descriptor_array::dof_descriptor* _xfr_desc;

  char* _dofs;

  bool _this_owns_dofs;

  void init_dofs(void* xdofs, size_t xdofs_ub);

  static bool make_prototype();

  void reserve(size_t xdof_tuple_ub);
};

} // namespace fiber_bundle

#endif // ifndef ARRAY_SECTION_DOF_MAP_H