CrvCubicHmt.h

Go to the documentation of this file.

//  
//  For more information, please see: http://software.sci.utah.edu
//  
//  The MIT License
//  
//  Copyright (c) 2009 Scientific Computing and Imaging Institute,
//  University of Utah.
//  
//  
//  Permission is hereby granted, free of charge, to any person obtaining a
//  copy of this software and associated documentation files (the "Software"),
//  to deal in the Software without restriction, including without limitation
//  the rights to use, copy, modify, merge, publish, distribute, sublicense,
//  and/or sell copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following conditions:
//  
//  The above copyright notice and this permission notice shall be included
//  in all copies or substantial portions of the Software.
//  
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
//  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//  DEALINGS IN THE SOFTWARE.
//  
///    @file    CrvCubicHmt.h
///    @author  Martin Cole, Frank B. Sachse
///    @date    Dec 04 2004

#ifndef CORE_BASIS_CRVCUBICHMT_H
#define CORE_BASIS_CRVCUBICHMT_H 1

#include <Core/Basis/CrvLinearLgn.h>

namespace SCIRun {
namespace Core {
namespace Basis {

/// Class for describing unit geometry of CrvCubicHmt 
class CrvCubicHmtUnitElement : public CrvLinearLgnUnitElement {
public:
  CrvCubicHmtUnitElement() {}
  virtual ~CrvCubicHmtUnitElement() {}

  static int dofs() { return 4; } ///< return degrees of freedom
};


/// Class for handling of element of type curve with 
/// cubic hermitian interpolation
template <class T>
class CrvCubicHmt : public BasisAddDerivatives<T>, 
                    public CrvApprox, 
            public CrvGaussian3<double>, 
        public CrvSamplingSchemes, 
            public CrvCubicHmtUnitElement,
            public CrvElementWeights
{
public:
  typedef T value_type;

  static int    GaussianNum;
  static double GaussianPoints[3][1];
  static double GaussianWeights[3];
  
  CrvCubicHmt() {}
  virtual ~CrvCubicHmt() {}
  
  
  static int polynomial_order() { return 3; }

  template<class VECTOR>
  inline void get_weights(const VECTOR& coords, double *w) const
    { get_cubic_weights(coords,w); }

  template<class VECTOR>
  inline void get_derivate_weights(const VECTOR& coords, double *w) const
    { get_cubic_derivate_weights(coords,w); }
              
  /// get value at parametric coordinate
  template <class ElemData, class VECTOR>
  T interpolate(const VECTOR &coords, const ElemData &cd) const
  {
    double w[4];
    get_cubic_weights(coords,w); 
    return T(
       w[0] * cd.node0() +
         w[1] * this->derivs_[cd.node0_index()][0] +
         w[2] * cd.node1() +
         w[3] * this->derivs_[cd.node1_index()][0]);
  }

  /// get first derivative at parametric coordinate
  template <class ElemData, class VECTOR1, class VECTOR2>
  void derivate(const VECTOR1 &coords, const ElemData &cd, 
        VECTOR2 &derivs) const
  {
    double w[4];
    get_cubic_derivate_weights(coords,w);

    derivs.resize(1);
    derivs[0] = static_cast<typename VECTOR2::value_type>(
        w[0] * cd.node0() +
            w[1] * this->derivs_[cd.node0_index()][0] +
        w[2] * cd.node1() +
            w[3] * this->derivs_[cd.node1_index()][0]);
  }

  /// get parametric coordinate for value within the element
  template <class ElemData, class VECTOR>
  bool get_coords(VECTOR &coords, const T& value, 
          const ElemData &cd) const  
  {
    CrvLocate< CrvCubicHmt<T> > CL;
    return CL.get_coords(this, coords, value, cd);
  }
     
  /// get arc length for edge
  template <class ElemData>
  double get_arc_length(const unsigned edge, const ElemData &cd) const  
  {
    return get_arc1d_length<CrvGaussian3<double> >(this, edge, cd);
  }
 
  /// get area
  template <class ElemData>
    double get_area(const unsigned /* face */, const ElemData & /* cd */) const  
  {
    return 0.;
  }
 
  /// get volume
  template <class ElemData>
    double get_volume(const ElemData & /* cd */) const  
  {
    return 0.;
  }

  static  const std::string type_name(int n = -1);

  virtual void io (Piostream& str);

};

template <class T>
const std::string
CrvCubicHmt<T>::type_name(int n)
{
  ASSERT((n >= -1) && n <= 1);
  if (n == -1)
  {
    static const std::string name = TypeNameGenerator::make_template_id(type_name(0), type_name(1));
    return name;
  }
  else if (n == 0)
  {
    static const std::string nm("CrvCubicHmt");
    return nm;
  } else {
    return find_type_name((T *)0);
  }
}




}}

template <class T>
const TypeDescription* get_type_description(Core::Basis::CrvCubicHmt<T> *)
{
  static TypeDescription* td = 0;
  if(!td){
    const TypeDescription *sub = get_type_description((T*)0);
    TypeDescription::td_vec *subs = new TypeDescription::td_vec(1);
    (*subs)[0] = sub;
    td = new TypeDescription("CrvCubicHmt", subs, 
      std::string(__FILE__),
      "SCIRun", 
      TypeDescription::BASIS_E);
  }
  return td;
}

const int CRVCUBICHMT_BASIS_VERSION = 1;
template <class T>
void
  Core::Basis::CrvCubicHmt<T>::io(Piostream &stream)
{
  stream.begin_class(get_type_description(this)->get_name(),
    CRVCUBICHMT_BASIS_VERSION);
  Pio(stream, this->derivs_);
  stream.end_class();
}

}

#endif