sparse_field_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.
//

// $$SCRIBBLE: remove this class from build.

// Interface for class sparse_field_dof_map;
// This representation uses contiguous storage with
// the fiber index varying most rapidly

#ifndef SPARSE_FIELD_DOF_MAP_H
#define SPARSE_FIELD_DOF_MAP_H

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

#ifndef FIELD_DOF_MAP_H
#include "SheafSystem/field_dof_map.h"
#endif

namespace sheaf
{
class dof_map_factory;
}

namespace fiber_bundle
{

class sec_rep_space;


class SHEAF_DLL_SPEC sparse_field_dof_map : public field_dof_map
{

public:

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

  static const std::string& static_class_name();

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

  sparse_field_dof_map();

  virtual sparse_field_dof_map* clone() const;

  sparse_field_dof_map(const sparse_field_dof_map& xother);

  virtual sparse_field_dof_map* copy() const;

  sparse_field_dof_map& operator=(const sparse_field_dof_map& xother);

  virtual ~sparse_field_dof_map();

  virtual bool invariant() const;

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

  sparse_field_dof_map(const sec_rep_space* xhost, double xdefault_value = 0.0);

  

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

  inline double default_value() const
  {
    return _def_val;
  };

  using field_dof_map::get_dof;
  using field_dof_map::put_dof;

  virtual void get_dof(const scoped_index& xid, bool xis_poset_id,
                       void *xbuf, size_t xbuf_len) const;

  virtual void put_dof(const scoped_index& xid, bool xis_poset_id,
                       const void *xbuf, size_t xbuf_len);

  virtual void get_dofs(const client_index* xclient_ids, int xclient_id_ct,
                        void* xbuf, size_t xbuf_len) const;

  virtual void put_dofs(const client_index* xclient_ids, int xclient_id_ct,
                        const void* xbuf, size_t xbuf_len);

  virtual void get_dof(const scoped_index& xbase_id,
                       const scoped_index& xfiber_id,
                       const scoped_index& xmult_id,
                       bool xis_poset_id,
                       void* xbuf, size_t xbuf_len) const;

  virtual void put_dof(const scoped_index& xbase_id,
                       const scoped_index& xfiber_id,
                       const scoped_index& xmult_id,
                       bool xis_poset_id,
                       const void* xbuf, size_t xbuf_len);

  virtual void get_dofs(const client_index* xclient_base_ids, int xclient_base_id_ct,
                        const client_index* xclient_fiber_ids, int xclient_fiber_id_ct,
                        void* xbuf, size_t xbuf_len) const;

  virtual void put_dofs(const client_index* xclient_base_ids, int xclient_base_id_ct,
                        const client_index* xclient_fiber_ids, int xclient_fiber_id_ct,
                        const void* xbuf, size_t xbuf_len);

  virtual void get_discretization_dofs(const scoped_index& xdisc_id,
                                       bool xis_poset_id,
                                       void* xbuf,
                                       size_t xbuf_len) const;
  virtual void put_discretization_dofs(const scoped_index& xdisc_id,
                                       bool xis_poset_id,
                                       const void* xbuf,
                                       size_t xbuf_len);
  virtual void get_component_dofs(void* xbuf,
                                  size_t xbuf_len,
                                  const scoped_index& xcomp_id,
                                  const scoped_index* xdisc_ids = 0,
                                  size_type xdisc_ids_ct = 0) const;

  virtual void put_component_dofs(const void* xbuf,
                                  size_t xbuf_len,
                                  const scoped_index& xcomp_id,
                                  const scoped_index* xdisc_ids = 0,
                                  size_type xdisc_ids_ct = 0);

  virtual void get_component_dofs(void* xbuf,
                                  size_t xbuf_len,
                                  const client_index& xcomp_id,
                                  const id_map* xcomp_client_id_map,
                                  const client_index* xdisc_ids = 0,
                                  size_type xdisc_ids_ct = 0,
                                  const id_map* xdisc_client_id_map = 0) const;

  virtual void put_component_dofs(const void* xbuf,
                                  size_t xbuf_len,
                                  const client_index& xcomp_id,
                                  const id_map* xcomp_client_id_map,
                                  const client_index* xdisc_ids = 0,
                                  size_type xdisc_ids_ct = 0,
                                  const id_map* xdisc_client_id_map = 0);
  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:

  virtual void allocate_dofs();

private:

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

  val_map_type _val_map;

  double _def_val;

  static bool _has_prototype;

  static bool make_prototype();

};

} // namespace fiber_bundle

#endif // ifndef SPARSE_FIELD_DOF_MAP_H