include/ewalena/numerics/ferroelectric_field.h

Go to the documentation of this file.

// -------------------------------------------------------------------
// @author Toby D. Young
// @version $Id: ferroelectric_field.h 988 2012-11-26 19:09:39Z oneliefleft $
//
// Copyright 2010 namespace ewalena authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above
//    copyright notice, this list of conditions and the following
//    disclaimer in the documentation and/or other materials provided
//    with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE NAMEPSACE EWALENA AUTHORS ``AS
// IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// NAMESPACE EWALENA AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//
// The views and conclusions contained in the software and
// documentation are those of the authors and should not be
// interpreted as representing official policies, either expressed or
// implied, of the namespace ewalena authors.
// -------------------------------------------------------------------

#ifndef __ewalena_ferroelectric_field_h
#define __ewalena_ferroelectric_field_h

#ifdef EWALENA_HAVE_CONFIG_H
#include <ewalena/base/config.h>
#endif

#include <ewalena/numerics/crystal_field_base.h>

namespace ewalena
{
  
  namespace Crystal
  {
    
    template <typename ValueType = double>
      class FerroelectricField
      : 
      public Crystal::CrystalFieldBase<3, 1, ValueType>
      {
      protected:
      
      void distribute_moduli_to_hexagonal ();
      
      void distribute_moduli_to_cubic ();
      
      public:
      
      FerroelectricField (const Vector<ValueType> &moduli         = Vector<ValueType> (),
                          const SymmetryFlag      &symmetry_flags = SymmetryFlag::null) 
      : 
      CrystalFieldBase<3, 1, ValueType> (moduli, symmetry_flags)
      {}
      
      virtual ~FerroelectricField ();
      
      void distribute_moduli (const Vector<ValueType> &moduli);
      
      inline  
      ewalena::Crystal::CrystalFieldBase<3, 1, ValueType> operator* () const  
      {  
        return (*this);  
      }
      
      }; /* FerroelectricField */
  
  } /* namespace Crystal */

} /* namespace ewalena */

#endif /* __ewalena_ferroelectric_field_h */