e4.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 E4_H
#define E4_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 E4_ROW_DOFS_TYPE
//==============================================================================

template <typename T>
class e4_row_dofs_type
{
public:

  typedef T dof_type;

  typedef e4_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;

  e4_row_dofs_type<T>* clone() const;

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

  T components[4];

protected:
private:

};

//==============================================================================
// CLASS E4_LITE
//==============================================================================

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

public:

  // Typedefs:

  typedef e4_row_dofs_type<double> row_dofs_type;

  e4_lite();

  e4_lite(const e4_lite& xother);

  e4_lite& operator=(const e4_lite& xother);

  virtual ~e4_lite();

  e4_lite(const row_dofs_type& xrow_dofs);

  e4_lite& operator=(const row_dofs_type& xrow_dofs);

  e4_lite(const value_type& x0,
          const value_type& x1,
          const value_type& x2,
          const value_type& x3);

  operator row_dofs_type& ();

  operator const row_dofs_type& () const;

  using ed_lite::put_components;

  virtual void put_components(const value_type& x0,
                              const value_type& x1,
                              const value_type& x2,
                              const value_type& x3);


protected:

  row_dofs_type _row_dofs;

private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:

  typedef e4_lite vector_space_type;

  virtual int dd() const;

protected:
private:



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

public:

  bool operator==(const e4_lite& xother) 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:
protected:
private:



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

public:

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

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

  virtual e4_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 E4
//==============================================================================

class tp_space;
class tp;
class atp;
class stp;

class SHEAF_DLL_SPEC e4 : 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 e4_row_dofs_type<double> row_dofs_type;

  typedef e4_lite volatile_type;

  typedef e4 vector_space_type;

  e4();

  // New handle/old state constructors.

  e4(const poset_state_handle* xhost, pod_index_type xhub_id);

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

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

  explicit e4(abstract_poset_member* xother);

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

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

  e4& operator=(const row_dofs_type& xrdt);

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

  e4& operator=(const e4& xother);

  ~e4();

  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 x0,
                              dof_type x1,
                              dof_type x2,
                              dof_type x3);

  operator row_dofs_type& ();

  operator const row_dofs_type& () const;

protected:
private:



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

public:

  //@todo: Reword comments.
  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 e4* clone() const;

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

protected:
public:



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

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 e4_row_dofs_type<T>& xrdt);


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

// Forward declarations needed for specialization:

class at0_lite;
class at2_e4_lite;
class at3_e4_lite;
class st2_e4_lite;
class st3_e4_lite;
class st4_e4_lite;
class t2_e4_lite;
class t3_e4_lite;
class t4_e4_lite;

class at0;
class at2_e4;
class at3_e4;
class st2_e4;
class st3_e4;
class st4_e4;
class t2_e4;
class t3_e4;
class t4_e4;


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

  typedef at0_lite atp_type;

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

  typedef e4_lite atp_type;

  typedef e4_lite stp_type;
};
  
template<> class tensor_traits<2, e4_lite>
{
public:
  typedef t2_e4_lite tp_type;

  typedef at2_e4_lite atp_type;

  typedef st2_e4_lite stp_type;
};
  
template<> class tensor_traits<3, e4_lite>
{
public:
  typedef t3_e4_lite tp_type;

  typedef at3_e4_lite atp_type;

  typedef st3_e4_lite stp_type;
};
  
template<> class tensor_traits<4, e4_lite>
{
public:
  typedef t4_e4_lite tp_type;

  typedef void atp_type;

  typedef st4_e4_lite stp_type;
};

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

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

  typedef at0 atp_type;

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

  typedef e4 atp_type;

  typedef e4 stp_type;
};
  
template<> class tensor_traits<2, e4>
{
public:
  typedef t2_e4 tp_type;

  typedef at2_e4 atp_type;

  typedef st2_e4 stp_type;
};
  
template<> class tensor_traits<3, e4>
{
public:
  typedef t3_e4 tp_type;

  typedef at3_e4 atp_type;

  typedef st3_e4 stp_type;
};
  
template<> class tensor_traits<4, e4>
{
public:
  typedef t4_e4 tp_type;

  typedef void atp_type;

  typedef st4_e4 stp_type;
};


} // namespace fiber_bundle

 
#endif // ifndef E4_H