e3.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 E3_H
#define E3_H

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

#ifndef ED_H
#include "SheafSystem/ed.h"
#endif

namespace fiber_bundle
{

class atp;
class stp;
class tp;


//==============================================================================
// CLASS E3_ROW_DOFS_TYPE
//==============================================================================

template <typename T>
class e3_row_dofs_type
{
public:

  typedef T dof_type;

  typedef e3_row_dofs_type<T> row_dofs_type;

  static const std::string& static_class_name();
  
  static int d();

  T& operator[] (int xindex);

  const T& operator[] (int xindex) const;

  e3_row_dofs_type<T>* clone() const;

  e3_row_dofs_type<T>* clone(bool xnew_state, bool xauto_access) const
  {
    return clone();
  }

  T components[3];

protected:
private:

};

//==============================================================================
// CLASS E3_LITE
//==============================================================================

class SHEAF_DLL_SPEC e3_lite : public ed_lite
{
  //============================================================================
  //============================================================================

public:

  // Typedefs:

  typedef e3_row_dofs_type<double> row_dofs_type;

  e3_lite();

  e3_lite(const e3_lite& xother);

  e3_lite& operator=(const e3_lite& xother);

  virtual ~e3_lite();

  e3_lite(const row_dofs_type& xrow_dofs);

  e3_lite& operator=(const row_dofs_type& xrow_dofs);

  explicit e3_lite(const value_type& xvalue);

  e3_lite(const value_type& x_comp,
          const value_type& y_comp,
          const value_type& z_comp);

  operator row_dofs_type& ();

  operator const row_dofs_type& () const;

  using ed_lite::put_components;

  virtual void put_components(const value_type& x_comp,
                              const value_type& y_comp,
                              const value_type& z_comp);


protected:

  row_dofs_type _row_dofs;

private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:

  typedef e3_lite vector_space_type;

  virtual int dd() const;

protected:
private:



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

public:

  bool operator==(const e3_lite& xother) const;
 
  e3_lite& operator=(const value_type& xvalue);

  bool operator==(const value_type& xvalue) const;

  static const tp_lite& static_tp_prototype(int xp);

  virtual const tp_lite& tp_prototype(int xp) const;

  static const atp_lite& static_atp_prototype(int xp);

  virtual const atp_lite& atp_prototype(int xp) const;

  static const stp_lite& static_stp_prototype(int xp);

  virtual const stp_lite& stp_prototype(int xp) const;

protected:
private:



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

public:

  bool c_lt(const e3_lite& xother) const;

  bool c_le(const e3_lite& xother) const;

  bool c_gt(const e3_lite& xother) const;

  bool c_ge(const e3_lite& xother) const;

  bool d_lt(const e3_lite& xother) const;

  bool d_le(const e3_lite& xother) const;

  bool d_gt(const e3_lite& xother) const;

  bool d_ge(const e3_lite& xother) const;
  
protected:
private:



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

public:

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

  static const std::string& static_class_name();
  
  virtual e3_lite* clone() const;

  virtual e3_lite* clone(bool xnew_state, bool xauto_access) const
  {
    return clone();
  }

protected:
private:




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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;

  virtual void* row_dofs();

  virtual const void* row_dofs() const;

protected:
private:

};


//==============================================================================
// CLASS E3
//==============================================================================

class tp_space;

class SHEAF_DLL_SPEC e3 : public ed
{
  // ===========================================================
  // ===========================================================

public:

  static const poset_path& standard_schema_path();

  static void make_standard_schema(namespace_poset& xns);

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

  static host_type& standard_host(namespace_type& xns, const std::string& xsuffix, bool xauto_access);

protected:

private:



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

public:

  // Typedefs:

  typedef e3_row_dofs_type<double> row_dofs_type;

  typedef e3_lite volatile_type;

  typedef e3 vector_space_type;

  e3();

  // New handle/old state constructors.

  e3(const poset_state_handle* xhost, pod_index_type xhub_id);

  e3(const poset_state_handle* xhost, const scoped_index& xid);

  e3(const poset_state_handle* xhost, const std::string& xname);

  explicit e3(abstract_poset_member* xother);

  e3(poset_state_handle* xhost, bool xauto_access = true);

  e3(poset_state_handle& xhost,
     const row_dofs_type& xrdt,
     bool xauto_access = true);

  e3& operator=(const row_dofs_type& xrdt);

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

  e3& operator=(const e3& xother);

  ~e3();

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;

protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:

  using ed::put_components;

  virtual void put_components(dof_type x_comp,
                              dof_type y_comp,
                              dof_type z_comp);

  operator row_dofs_type& ();

  operator const row_dofs_type& () const;

protected:
private:



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

public:

  static tp* new_tp(tp_space& xvector_space, int xp);

  static atp* new_atp(tp_space& xvector_space, int xp);

  static stp* new_stp(tp_space& xvector_space, int xp);

  virtual tp* new_tp(int xp, bool xauto_access) const;

  virtual atp* new_atp(int xp, bool xauto_access) const;

  virtual stp* new_stp(int xp, bool xauto_access) const;

protected:
private:



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

public:

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

  static const std::string& static_class_name();
  
  virtual e3* clone() const;

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

protected:
private:



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

public:

  bool is_ancestor_of(const any* xother) const;

  bool invariant() const;


protected:
private:

};

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

template <typename T>
std::ostream& operator<<(std::ostream& xos, const e3_row_dofs_type<T>& xrdt);

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

//==============================================================================
// E3 FACET:
//==============================================================================

namespace e3_algebra
{

void SHEAF_DLL_SPEC cross(const e3& x0, const e3& x1, e3& xresult, bool xauto_access);

void SHEAF_DLL_SPEC cross_equal(e3& xresult, const e3& xother, bool xauto_access);

SHEAF_DLL_SPEC e3_lite* cross(const e3_lite& x0, const e3_lite& x1);

void SHEAF_DLL_SPEC cross(const e3_lite& x0, const e3_lite& x1, e3_lite& xresult);

void SHEAF_DLL_SPEC cross_equal(e3_lite& xresult, const e3_lite& xother);

SHEAF_DLL_SPEC e3_lite* operator^(const e3_lite& x0, const e3_lite& x1);

SHEAF_DLL_SPEC e3_lite& operator^=(e3_lite& xresult, const e3_lite& xother);
  
} // namespace e3_algebra

//==============================================================================
// TP FACET
//==============================================================================

// Forward declarations needed for specialization:

class at0_lite;
class at2_e3_lite;
class at3_e3_lite;
class st2_e3_lite;
class st3_e3_lite;
class st4_e3_lite;
class t2_e3_lite;
class t3_e3_lite;
class t4_e3_lite;

class at0;
class at2_e3;
class at3_e3;
class st2_e3;
class st3_e3;
class st4_e3;
class t2_e3;
class t3_e3;
class t4_e3;


template<> class tensor_traits<0, e3_lite>
{
public:
  typedef at0_lite tp_type;

  typedef at0_lite atp_type;

  typedef at0_lite stp_type;
};
  
template<> class tensor_traits<1, e3_lite>
{
public:
  typedef e3_lite tp_type;

  typedef e3_lite atp_type;

  typedef e3_lite stp_type;
};
  
template<> class tensor_traits<2, e3_lite>
{
public:
  typedef t2_e3_lite tp_type;

  typedef at2_e3_lite atp_type;

  typedef st2_e3_lite stp_type;
};
  
template<> class tensor_traits<3, e3_lite>
{
public:
  typedef t3_e3_lite tp_type;

  typedef at3_e3_lite atp_type;

  typedef st3_e3_lite stp_type;
};
  
template<> class tensor_traits<4, e3_lite>
{
public:
  typedef t4_e3_lite tp_type;

  typedef void atp_type;

  typedef st4_e3_lite stp_type;
};

template<> class tensor_traits<0, e3>
{
public:
  typedef at0 tp_type;

  typedef at0 atp_type;

  typedef at0 stp_type;
};
  
template<> class tensor_traits<1, e3>
{
public:
  typedef e3 tp_type;

  typedef e3 atp_type;

  typedef e3 stp_type;
};
  
template<> class tensor_traits<2, e3>
{
public:
  typedef t2_e3 tp_type;

  typedef at2_e3 atp_type;

  typedef st2_e3 stp_type;
};
  
template<> class tensor_traits<3, e3>
{
public:
  typedef t3_e3 tp_type;

  typedef at3_e3 atp_type;

  typedef st3_e3 stp_type;
};
  
template<> class tensor_traits<4, e3>
{
public:
  typedef t4_e3 tp_type;

  typedef void atp_type;

  typedef st4_e3 stp_type;
};


class gl3_lite;

//==============================================================================
// VD FACET
//==============================================================================

namespace vd_algebra
{

//@hack Need to move this to vd.h.

SHEAF_DLL_SPEC void transform_basis_by(e3_lite& xv, const gl3_lite& xtransform,
                       bool is_contravariant = true);

SHEAF_DLL_SPEC void add(const e3_lite& x0, const e3_lite& x1, vd_value_type xt, e3_lite& xresult);

// ===========================================================
// VECTOR ALGEBRA: TOLERANCE COMPARISON
// ===========================================================

SHEAF_DLL_SPEC bool a_eql(const e3_lite& x0, const e3_lite& x1);
  
SHEAF_DLL_SPEC bool a_eql(const e3_lite& x0, const e3_lite& x1, double xtolerance);
  
SHEAF_DLL_SPEC bool a_eql(const e3_lite& x0, const e3_lite& x1, const e3_lite& xtolerance);

SHEAF_DLL_SPEC bool r_eql(const e3_lite& x0, const e3_lite& x1);
  
SHEAF_DLL_SPEC bool r_eql(const e3_lite& x0, const e3_lite& x1, double xtolerance);
  
SHEAF_DLL_SPEC bool r_eql(const e3_lite& x0, const e3_lite& x1, const e3_lite& xtolerance);
  
SHEAF_DLL_SPEC bool c_eql(const e3_lite& x0, const e3_lite& x1);
  
SHEAF_DLL_SPEC bool c_eql(const e3_lite& x0, const e3_lite& x1, double xtolerance);
  
SHEAF_DLL_SPEC bool c_eql(const e3_lite& x0, const e3_lite& x1, const e3_lite& xtolerance);
  
} // namespace vd_algebra

} // namespace fiber_bundle

#endif // ifndef E3_H