sparse_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 sparse_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 SPARSE_SECTION_DOF_MAP_H
#define SPARSE_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

#ifndef STD_UNORDERED_MAP_H
#include "SheafSystem/std_unordered_map.h"
#endif

namespace fiber_bundle
{

class sec_rep_space;

class SHEAF_DLL_SPEC sparse_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
  // ===========================================================

  sparse_section_dof_map();

  sparse_section_dof_map(const sparse_section_dof_map& xother);

  sparse_section_dof_map(sec_rep_space* xhost, double xdefault_value = 0.0);

  virtual sparse_section_dof_map* clone() const;

  virtual sparse_section_dof_map* copy() const;

  sparse_section_dof_map& operator=(const sparse_section_dof_map& xother);

  virtual ~sparse_section_dof_map();

  inline double default_value()
  {
    return _def_val;
  };

  virtual bool invariant() const;

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

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

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

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

public:
 
  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 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 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:

  typedef unordered::unordered_map<pod_index_type, double> val_map_type;

  val_map_type _val_map;

  double _def_val;


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);


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

  virtual bool supports_xfr_opt() const;


protected:

/*   /// */
/*   /// Copies the values of the dofs referred to by the  client ids in */
/*   /// xclient_base_ids x xclient_fiber_ids to or from */
/*   /// the buffer of length xbuf_len bytes starting at xbuf. */
/*   /// */
/*   void copy_dofs(client_index* xclient_base_ids, int xclient_base_id_ct, */
/*                  client_index* xclient_fiber_ids, int xclient_fiber_id_ct, */
/*                  void* xbuf, size_t xbuf_len, bool to_client); */

  virtual void allocate_dofs();

private:

  static bool make_prototype();

};

} // namespace fiber_bundle

#endif // ifndef SPARSE_SECTION_DOF_MAP_H