sec_vd.h

Go to the documentation of this file.

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


#ifndef SEC_VD_H
#define SEC_VD_H

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

#ifndef SEC_TUPLE_H
#include "SheafSystem/sec_tuple.h"
#endif

#ifndef AT0_H
#include "SheafSystem/at0.h"
#endif
 
namespace fiber_bundle
{

class at0;
class at0_lite;
class chart_point;
class sec_at0;
class sec_vd_space;
class vd;
class vd_lite;

//==============================================================================
// CLASS SEC_VD
//==============================================================================

class SHEAF_DLL_SPEC sec_vd : public sec_tuple
{

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

public:


  typedef sec_vd_space host_type;

  typedef vd fiber_type;

  typedef chart_point_coord_type coord_type;

  typedef sec_vd_value_type value_type;

  typedef sec_vd_dof_type dof_type;

  typedef sec_at0 scalar_type;

  static host_type& new_host(namespace_type& xns, 
                             const poset_path& xhost_path, 
                             const poset_path& xschema_path,
                             const poset_path& xscalar_space_path,
                             bool xauto_access);

protected:

private:

 

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

public:

  sec_vd();

  sec_vd(const sec_rep_space* xhost, pod_index_type xhub_id);

  sec_vd(const sec_rep_space* xhost, const scoped_index& xid);

  sec_vd(const sec_rep_space* xhost, const std::string& xname);

  sec_vd(const namespace_poset* xnamespace,
         const poset_path& xpath,
         bool xauto_access = true);

  explicit sec_vd(sec_rep_space_member* xother);

  sec_vd(sec_rep_space* xhost,
         section_dof_map* xdof_map = 0,
         bool xauto_access = true);

  sec_vd(sec_rep_space* xhost,
         abstract_poset_member& xbase_mbr,
         int xbase_version = CURRENT_HOST_VERSION,
         bool xauto_access = true);

  virtual sec_vd& operator=(const abstract_poset_member& xother);

  sec_vd& operator=(const sec_vd& xother);

  sec_vd& operator=(const vd& xfiber);

  sec_vd& operator=(const vd_lite& xfiber);

  ~sec_vd();

  bool fiber_is_ancestor_of(const any* xother) const;

  virtual const fiber_type& fiber_prototype() const;

  virtual int d() const;

  virtual int d(bool xauto_access) const;

  poset_path scalar_space_path() const;

  poset_path scalar_space_path(bool xauto_access) const;

  virtual bool is_vector(bool xauto_access) const;

  virtual void put_is_vector(bool xauto_access);

  virtual bool is_covector(bool xauto_access) const;;

  virtual void put_is_covector(bool xauto_access);

  scalar_type* comp(int i) const;

  void set_comp(int i, scalar_type* xcomponent);

  vd* value_at_point(const chart_point& xpt, bool xauto_access = true) const;

  virtual void value_at_point_pa(const chart_point& xpt,
                                 vd& xresult,
                                 bool xauto_access = true) const;

  virtual void value_at_point_ua(const chart_point& xpt,
                                 value_type* xresult,
                                 size_type xresult_ub,
                                 bool xauto_access = true) const;

  virtual int dof_packet_ub();

  void dof_tuple(dof_type* xbuf, int xbuflen) const;

  sec_vd* deep_copy(bool xauto_access);

  void deep_copy(sec_vd& xother, bool xauto_access);

protected:

  virtual sec_tuple::scalar_type* new_comp();

private:


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

public:

protected:

private:

 

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

  sec_vd* unify(bool xauto_access);

  void unify(sec_vd& xresult, bool xauto_access);

protected:

private:


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

public:

  using sec_tuple::get_fiber;
  
  void get_fiber(pod_index_type xdisc_id, vd_lite& xfiber) const;

  void get_fiber(const scoped_index& xdisc_id, vd_lite& xfiber, bool xauto_access) const;

  using sec_tuple::put_fiber;
  
  void put_fiber(pod_index_type xdisc_id, const vd_lite& xfiber);

  void put_fiber(const scoped_index& xdisc_id, const vd_lite& xfiber, bool xauto_access);

  using sec_tuple::force_fiber;
  
  void force_fiber(pod_index_type xdisc_id, const vd_lite& xfiber);

  void force_fiber(const scoped_index& xdisc_id, const vd_lite& xfiber, bool xauto_access);

protected:

private:


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

public:

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

  static const std::string& static_class_name();

  virtual sec_vd* clone() const;

  inline sec_vd* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<sec_vd*>(sec_tuple::clone(xnew_state, xauto_access));
  }

protected:

private:

 

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

public:

  host_type* host() const;

  virtual bool host_is_ancestor_of(const poset_state_handle* other) const;

protected:

private:



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

public:

  bool is_ancestor_of(const any* xother) const;

  bool invariant() const;

protected:

private:


}; // end of class sec_vd


//==============================================================================
// NON-MEMBER CLASSES
//==============================================================================

//==============================================================================
// TENSOR SECTION TRAITS
//==============================================================================

// Forward declarations needed for specialization:

class sec_tp;
class sec_t2;
class sec_t3;
class sec_t4;
class sec_atp;
class sec_at2;
class sec_at3;
class sec_stp;
class sec_st2;
class sec_st3;
class sec_st4;

template <int P, typename VECTOR_TYPE>
class tensor_section_traits
{
public:
  typedef void tp_type;

  typedef void atp_type;

  typedef void stp_type;
};

template <int P>
class tensor_section_traits<P, sec_vd>
{
public:
  typedef sec_tp tp_type;

  typedef sec_atp atp_type;

  typedef sec_stp stp_type;
};

template <>
class tensor_section_traits<0, sec_vd>
{
public:
  typedef at0 tp_type;

  typedef at0 atp_type;

  typedef at0 stp_type;
};

template <>
class tensor_section_traits<1, sec_vd>
{
public:
  typedef sec_vd tp_type;

  typedef sec_vd atp_type;

  typedef sec_vd stp_type;
};

template <>
class tensor_section_traits<2, sec_vd>
{
public:
  typedef sec_t2 tp_type;

  typedef sec_at2 atp_type;

  typedef sec_st2 stp_type;
};

template <>
class tensor_section_traits<3, sec_vd>
{
public:
  typedef sec_t3 tp_type;

  typedef sec_at3 atp_type;

  typedef sec_st3 stp_type;
};

template <>
class tensor_section_traits<4, sec_vd>
{
public:
  typedef sec_t4 tp_type;

  typedef void atp_type;
  //typedef sec_at4 atp_type;

  typedef sec_st4 stp_type;
};

//==============================================================================
// NON-MEMBER FUNCTIONS
//==============================================================================

SHEAF_DLL_SPEC size_t deep_size(const sec_vd& x0, bool xinclude_shallow = true);

namespace sec_vd_algebra
{

SHEAF_DLL_SPEC void add(const sec_vd& x0, const sec_vd& x1, sec_vd& xresult,
            bool xauto_access);

SHEAF_DLL_SPEC void add_equal(sec_vd& xresult, const sec_vd& xother, bool xauto_access);

SHEAF_DLL_SPEC void subtract(const sec_vd& x0, const sec_vd& x1, sec_vd& xresult,
                 bool xauto_access);

SHEAF_DLL_SPEC void subtract_equal(sec_vd& xresult, const sec_vd& xother, bool xauto_access);

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void multiply(const sec_vd& x0, const sec_at0& x1, sec_vd& xresult,
                 bool xauto_access);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void multiply_equal(sec_vd& xresult, const sec_at0& xother, bool xauto_access);

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void multiply(const sec_vd& x0, const vd_value_type& x1, sec_vd& xresult,
                 bool xauto_access);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void multiply_equal(sec_vd& xresult, const vd_value_type& xother,
                   bool xauto_access);

SHEAF_DLL_SPEC void divide(const sec_vd& x0, const sec_at0& x1, sec_vd& xresult,
               bool xauto_access);

SHEAF_DLL_SPEC void divide_equal(sec_vd& xresult, const sec_at0& xother, bool xauto_access);

SHEAF_DLL_SPEC void divide(const sec_vd& x0, const vd_value_type& x1, sec_vd& xresult,
               bool xauto_access);

SHEAF_DLL_SPEC void divide_equal(sec_vd& xresult, const vd_value_type& xother,
                 bool xauto_access);

SHEAF_DLL_SPEC void contract(const sec_vd& xvector, const sec_vd& xcovector, sec_at0& xresult,
                 bool xauto_access);

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

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void max(const sec_vd& x0, vd_lite& xresult, bool xauto_access);

SHEAF_DLL_SPEC vd_lite* max(const sec_vd& x0, bool xauto_access);

SHEAF_DLL_SPEC void min(const sec_vd& x0, vd_lite& xresult, bool xauto_access);

SHEAF_DLL_SPEC vd_lite* min(const sec_vd& x0, bool xauto_access);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void extrema(const sec_vd& x0, vd_lite& xmin, vd_lite& xmax, bool xauto_access);


SHEAF_DLL_SPEC void extrema(const sec_vd& x0,
                sec_vd_value_type xmin[], size_type xmin_ub,
                sec_vd_value_type xmax[], size_type xmax_ub);

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

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void assign(sec_vd& x0, const sec_vd& x1, bool xauto_access);

SHEAF_DLL_SPEC void assign(sec_vd& x0, const vd_lite& x1, bool xauto_access);

SHEAF_DLL_SPEC void assign(sec_vd& x0, const vd_value_type& xvalue, bool xauto_access);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN


//==============================================================================
// BINARY AND UNARY OPERATORS.
//==============================================================================

template <typename S0, typename S1, typename SR, typename F>
void binary_op(const S0& x0, const S1& x1, SR& xresult, F xfunctor,
               bool xauto_access);

template <typename S0, typename SR, typename F>
void binary_op(const S0& x0, const vd_value_type& x1, SR& xresult, F xfunctor,
               bool xauto_access);

template <typename S0, typename SR, typename F>
void unary_op(const S0& x0, SR& xresult, F xfunctor,
              bool xauto_access);

template <typename S0, typename F>
void unary_op(S0& x0, const vd_value_type& x1, F xfunctor,
              bool xauto_access);

template <typename S0, typename SR, typename F>
void unary_op(const S0& x0, SR& xresult1, SR& xresult2, F xfunctor,
              bool xauto_access);

} // namespace sec_vd_algebra

} // namespace fiber_bundle

#endif // ifndef SEC_VD_H