st2_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 ST2_E3_H
#define ST2_E3_H

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

#ifndef ST2_H
#include "SheafSystem/st2.h"
#endif

#ifndef SYMMETRIC_MATRIX_3X3_H
#include "SheafSystem/symmetric_matrix_3x3.h"
#endif

#ifndef E3_H
#include "SheafSystem/e3.h"
#endif

namespace fiber_bundle
{

class gl3_lite;

//==============================================================================
// CLASS ST2_E3_ROW_DOFS_TYPE
//==============================================================================

template <typename T>
class st2_e3_row_dofs_type
{
public:

  typedef T dof_type;

  typedef st2_e3_row_dofs_type<T> row_dofs_type;

  typedef symmetric_matrix_3x3<T> matrix_type;

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

  T& operator[] (int xindex);

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

  operator typename st2_e3_row_dofs_type<T>::matrix_type& ();

  operator const typename st2_e3_row_dofs_type<T>::matrix_type& () const;

  st2_e3_row_dofs_type<T>* clone() const;

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

  T components[6];

protected:
private:

};


//==============================================================================
// CLASS ST2_E3_LITE
//==============================================================================

class e3_lite;

class SHEAF_DLL_SPEC st2_e3_lite : public st2_lite
{
  //============================================================================
  //============================================================================

public:

  // Typedefs:

  typedef st2_e3_row_dofs_type<double> row_dofs_type;

  typedef st2_e3_row_dofs_type<double>::matrix_type matrix_type;

  st2_e3_lite();

  st2_e3_lite(const st2_e3_lite& xother);

  st2_e3_lite& operator=(const st2_e3_lite& xother);

  virtual ~st2_e3_lite();

  st2_e3_lite(const row_dofs_type& xrow_dofs);

  st2_e3_lite& operator=(const row_dofs_type& xrow_dofs);

  st2_e3_lite(const matrix_type& xmatrix);

  st2_e3_lite& operator=(const matrix_type& xmatrix);

  operator matrix_type& ();

  operator const matrix_type& () const;

  operator row_dofs_type& ();

  operator const row_dofs_type& () const;

  st2_e3_lite(const value_type& xx, const value_type& xy, const value_type& xz,
              const value_type& yy, const value_type& yz, const value_type& zz);


  using st2_lite::put_components;
  
  virtual void put_components(const value_type& xx_comp,
                              const value_type& xy_comp,
                              const value_type& xz_comp,
                              const value_type& yy_comp,
                              const value_type& yz_comp,
                              const value_type& zz_comp);

protected:

  row_dofs_type _row_dofs;

private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:

  typedef e3_lite vector_space_type;

  virtual int dd() const;

protected:
private:



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

public:

  virtual const tp_lite& tp_prototype(int xp) const;

  virtual const atp_lite& atp_prototype(int xp) const;

  virtual const stp_lite& stp_prototype(int xp) const;

protected:
private:



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

public:
protected:
private:



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

public:

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

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

  virtual st2_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 ST2_E3
//==============================================================================


class SHEAF_DLL_SPEC st2_e3 : public st2
{
  // ===========================================================
  // ===========================================================

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& xvector_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 st2_e3_row_dofs_type<double> row_dofs_type;

  typedef st2_e3_lite volatile_type;

  typedef e3 vector_space_type;

  st2_e3();

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

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

  st2_e3& operator=(const row_dofs_type& xrdt);

  st2_e3(const poset_state_handle* xhost, pod_index_type xhub_id);

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

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

  explicit st2_e3(abstract_poset_member* xother);

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

  st2_e3& operator=(const st2_e3& xother);

  ~st2_e3();

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;


  using st2::put_components;
  
  virtual void put_components(
    dof_type xx_comp, dof_type xy_comp, dof_type xz_comp,
    dof_type yy_comp, dof_type yz_comp, dof_type zz_comp);

  operator row_dofs_type& ();

  operator const row_dofs_type& () const;

protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:




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

public:

  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 st2_e3* clone() const;

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


protected:
private:



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

public:

  bool is_ancestor_of(const any* other) const;

  bool invariant() const;

protected:
private:

};

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

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

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

namespace vd_algebra
{


SHEAF_DLL_SPEC void transform_basis_by(st2_e3_lite& xv, const gl3_lite& xtransform, bool is_contravariant);
  
} // namespace vd_algebra

//==============================================================================
// ST2 FACET
//==============================================================================

namespace st2_algebra
{

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void determinant(const st2_e3& x0, vd_value_type& xresult, bool xauto_access);

SHEAF_DLL_SPEC vd_value_type determinant(const st2_e3& x0, bool xauto_access);

SHEAF_DLL_SPEC void determinant(const st2_e3_lite& x0, vd_value_type& xresult);

SHEAF_DLL_SPEC vd_value_type determinant(const st2_e3_lite& x0);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

// ===========================================================
// TEMPLATE SPECIALIZATIONS
// ===========================================================

template <> SHEAF_DLL_SPEC void to_principal_axes(const st2_e3_lite& xlite, gl3_lite& xtransform, st2_e3_lite& xresult);
  
} // namespace st2_algebra

} // namespace fiber_bundle

#endif // ifndef ST2_E3_H