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

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

#ifndef ARRAY_FIELD_DOF_MAP_H
#define ARRAY_FIELD_DOF_MAP_H

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

#ifndef STD_STRING_H
#include "SheafSystem/std_string.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 array_field_dof_map : public field_dof_map
{

public:

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

  static const std::string& static_class_name();

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

  array_field_dof_map();

  virtual array_field_dof_map* clone() const;

  array_field_dof_map(const array_field_dof_map& xother);

  virtual array_field_dof_map* copy() const;

  array_field_dof_map& operator=(const array_field_dof_map& xother);

  virtual ~array_field_dof_map();

  virtual bool invariant() const;

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

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

  

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

  using field_dof_map::get_dof;
  using field_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, bool xis_poset_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:

  //
  sec_vd_dof_type* dof_ptr(pod_index_type xdof_id) const
  {
    return reinterpret_cast<sec_vd_dof_type*>(_dofs) + xdof_id;
  }

  //
  void* dof_ptr(pod_index_type xdisc_id, pod_index_type xfiber_dof_id) const
  {
    return _dofs + schema().offset(xdisc_id, xfiber_dof_id);
  }
    

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


protected:

  virtual void allocate_dofs();

private:

  int _disc_ct;

  int _fiber_ct;

  int _local_ct;

  int _fiber_tuple_size;

  double* _dofs;

  bool _this_owns_dofs;

  static bool _has_prototype;

  static bool make_prototype();

  void reserve(int xindex);
};

} // namespace fiber_bundle

#endif // ifndef ARRAY_FIELD_DOF_MAP_H