jcb_e13.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 JCB_E13_H
#define JCB_E13_H

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

#ifndef JCB_ED_H
#include "SheafSystem/jcb_ed.h"
#endif

#ifndef GENERAL_MATRIX_3X1_H
#include "SheafSystem/general_matrix_3x1.h"
#endif

#ifndef E1_H
#include "SheafSystem/e1.h"
#endif

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

namespace fiber_bundle
{
  class e1;
  class e3;
  
//==============================================================================
// CLASS JCB_E13_ROW_DOFS_TYPE
//==============================================================================

template <typename T>
class jcb_e13_row_dofs_type
{
public:

  typedef T dof_type;

  typedef jcb_e13_row_dofs_type<T> row_dofs_type;

  typedef general_matrix_3x1<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 jcb_e13_row_dofs_type<T>::matrix_type& ();

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

  jcb_e13_row_dofs_type<T>* clone() const;

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

  T components[3];

protected:
private:

};


//==============================================================================
// CLASS JCB_E13_LITE
//==============================================================================

class SHEAF_DLL_SPEC jcb_e13_lite : public jcb_ed_lite
{
  //============================================================================
  //============================================================================

public:

  // Typedefs:

  typedef jcb_e13_row_dofs_type<double> row_dofs_type;

  typedef jcb_e13_row_dofs_type<double>::matrix_type matrix_type;

  jcb_e13_lite();

  jcb_e13_lite(const jcb_e13_lite& xother);

  jcb_e13_lite& operator=(const jcb_e13_lite& xother);

  virtual ~jcb_e13_lite();

  jcb_e13_lite(const row_dofs_type& xrow_dofs);

  jcb_e13_lite& operator=(const row_dofs_type& xrow_dofs);

  jcb_e13_lite(const matrix_type& xmatrix);

  jcb_e13_lite& operator=(const matrix_type& xmatrix);

  operator matrix_type& ();

  operator const matrix_type& () const;

  operator row_dofs_type& ();

  operator const row_dofs_type& () const;

  jcb_e13_lite(const value_type& dxdu,
               const value_type& dydu,
               const value_type& dzdu);

  using jcb_ed_lite::put_components;
  
  virtual void put_components(const value_type& dxdu,
                              const value_type& dydu,
                              const value_type& dzdu);

protected:

  row_dofs_type _row_dofs;

private:



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

public:
protected:
private:



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

public:

  typedef e1_lite domain_space_type;

  typedef e3_lite range_space_type;

  virtual int dd() const;

  virtual int dr() const;

protected:
private:



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

public:

//   ///
//   /// Virtual constructor for general tensors 
//   /// of degree xp over this vector space.
//   ///
//   virtual tp_lite* new_tp_lite(int xp) const;

//   ///
//   /// Virtual constructor for antisymmetric tensors 
//   /// of degree xp over this vector space.
//   ///
//   virtual atp_lite* new_atp_lite(int xp) const;

//   ///
//   /// Virtual constructor for symmetric tensors 
//   /// of degree xp over this vector space.
//   ///
//   virtual stp_lite* new_stp_lite(int xp) const;

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

  virtual jcb_e13_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 JCB_E13
//==============================================================================


class SHEAF_DLL_SPEC jcb_e13 : public jcb_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& xdomain_path,
                 const poset_path& xrange_path,
                 bool xauto_access);

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

protected:

private:

 

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

public:

  // Typedefs:

  typedef e1 domain_type;

  typedef e3 range_type;

  typedef jcb_e13_row_dofs_type<double> row_dofs_type;

  typedef jcb_e13_lite volatile_type;

  jcb_e13();

  jcb_e13(const poset_state_handle* xhost, pod_index_type xhub_id);

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

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

  explicit jcb_e13(abstract_poset_member* xother);

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

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

  jcb_e13& operator=(const row_dofs_type& xrdt);

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

  jcb_e13& operator=(const jcb_e13& xother);

  ~jcb_e13();

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;

  //============================================================================
  // ROW DOF RELATED MEMBER FUNCTIONS
  //============================================================================

  virtual void put_components(dof_type dxdu_comp,
                              dof_type dydu_comp,
                              dof_type dzdu_comp);

  operator row_dofs_type& ();

  operator const row_dofs_type& () const;

protected:
private:



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

public:
protected:
private:



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

public:
  typedef e1 domain_space_type;

  typedef e3 range_space_type;

protected:
private:



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

public:
protected:
private:



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

public:

protected:

private:



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

public:

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

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

  inline jcb_e13* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<jcb_e13*>(jcb_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 jcb_e13_row_dofs_type<T>& xrdt);


class e1;
class e3;
class e1_lite;
class e3_lite;

//==============================================================================
// JCB FACET
//==============================================================================

namespace jcb_algebra
{

#ifndef DOXYGEN_SKIP_UNKNOWN

SHEAF_DLL_SPEC void push(const jcb_e13& xjcb,
             const e1& xvector,
             e3& xresult,
             bool xauto_access);

SHEAF_DLL_SPEC void push(const jcb_e13_lite& xjcb,
             const e1_lite& xvector,
             e3_lite& xresult);

SHEAF_DLL_SPEC e3_lite* push(const jcb_e13_lite& xjcb,
                 const e1_lite& xvector);

#endif // ifndef DOXYGEN_SKIP_UNKNOWN

SHEAF_DLL_SPEC void pull(const jcb_e13& xjcb,
             const e3& xcovector,
             e1& xresult,
             bool xauto_access);

SHEAF_DLL_SPEC void pull(const jcb_e13_lite& xjcb,
             const e3_lite& xcovector,
             e1_lite& xresult);

SHEAF_DLL_SPEC e1_lite* pull(const jcb_e13_lite& xjcb,
                 const e3_lite& xcovector);

} // namespace jcb_algebra

} // namespace fiber_bundle


#endif // ifndef JCB_E13_H