gln.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 GLN_H
#define GLN_H

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

#ifndef GROUP_H
#include "SheafSystem/group.h"
#endif

#ifndef GLN_TABLE_DOFS_TYPE_H
#include "SheafSystem/gln_table_dofs_type.h"
#endif

namespace fiber_bundle
{  
  //
  // Forward declarations
  //

  class at0;
  class at1;
  class gln_space;
  
//==============================================================================
// CLASS GLN_ROW_DOFS_TYPE
//==============================================================================
 
template <typename T>
class gln_row_dofs_type
{
public:

  typedef T dof_type;

  typedef gln_row_dofs_type<T> row_dofs_type;

  static const std::string& static_class_name();

  T& operator[] (int xindex);

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

  row_dofs_type* clone() const;
};


//==============================================================================
// CLASS GLN_LITE
//==============================================================================


class SHEAF_DLL_SPEC gln_lite : public group_lite
{
  //============================================================================
  //============================================================================

public:

  typedef vd_dof_type dof_type;

  typedef vd_value_type value_type;

  typedef gln_table_dofs_type table_dofs_type;

  typedef gln_row_dofs_type<double> row_dofs_type;

  gln_lite();

  gln_lite(const gln_lite& xother);

  gln_lite& operator=(const gln_lite& xother);

  virtual ~gln_lite();

  gln_lite(const row_dofs_type& xrow_dofs);

  gln_lite& operator=(const row_dofs_type& xrow_dofs);

  //virtual int n() const = 0;
  virtual int n() const;

  virtual int d() const;

  value_type component(int xindex) const;

  void put_component(int xindex, value_type xcomp);

  void components(dof_type xcomps[], int xcomps_dimension) const;

  void put_components(const dof_type xcomps[], int xcomps_dimension);

  value_type& operator[] (int xindex);

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

protected:
private:



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

public:
protected:
private:



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

public:

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

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

  table_dofs_type table_dofs() const;

protected:
private:



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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;

protected:
private:

};

//==============================================================================
// CLASS GLN
//==============================================================================

class SHEAF_DLL_SPEC gln : public group
{

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

public:

  typedef gln_space host_type;

  static const std::string& standard_schema_poset_name();

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

protected:

private:

 

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

public:

  // Typedefs:

  typedef at1 vector_space_type;

  typedef at0 scalar_type;

  typedef gln_table_dofs_type table_dofs_type;

  typedef gln_row_dofs_type<double> row_dofs_type;

  typedef gln_lite volatile_type;

  typedef vd_value_type value_type;

  typedef vd_dof_type dof_type;

  gln();

  gln(const gln& xother, bool xnew_jem);

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

  gln& operator=(const gln& xother);

  virtual ~gln();

  gln(poset* xhost, bool xauto_access = true);

  gln(const poset* xhost, pod_index_type xhub_id);

  gln(const poset* xhost, const scoped_index& xid);

  gln(const poset* xhost, const std::string& xname);

  explicit gln(gln* xother);

  int n() const;

  int n(bool xauto_access) const;

  poset_path scalar_space_path() const;

  poset_path scalar_space_path(bool xauto_access) const;

  poset_path vector_space_path() const;

  poset_path vector_space_path(bool xauto_access) const;

  virtual int d() const;

  int d(bool xauto_access) const;

  virtual value_type component(int xindex) const;

  value_type component(int xindex, bool xauto_access) const;

  virtual void put_component(int xi, value_type xvalue);

  void put_component(int xindex, value_type xvalue, bool xauto_access);

  void components(dof_type xcomps[], int xcomps_dimension) const;

  void put_components(const dof_type xcomps[], int xcomps_dimension);

  dof_type& operator[] (int xindex);

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

  virtual volatile_type* lite_type() const;


protected:
private:



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

public:
protected:
private:



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

public:

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

  static const std::string& static_class_name();

  inline gln* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<gln*>(group::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:

  virtual bool invariant() const;
  
  virtual gln* clone() const;  

  virtual bool is_ancestor_of(const any* xother) const;

protected:
private:

};

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

SHEAF_DLL_SPEC double rad(double degrees);

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC std::ostream& operator<<(std::ostream& xos, gln_lite& xv);

SHEAF_DLL_SPEC std::ostream& operator<<(std::ostream& xos, gln_lite::table_dofs_type& xt);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

} // namespace fiber_bundle

#endif // ifndef GLN_H