ewalena::Crystal::FerroelectricField< ValueType > Class Template Reference

Ferroelectric field. More...

#include <include/ewalena/numerics/ferroelectric_field.h>

Inheritance diagram for ewalena::Crystal::FerroelectricField< ValueType >:

Collaboration diagram for ewalena::Crystal::FerroelectricField< ValueType >:

List of all members.

Public Member Functions
void	distribute_moduli (const Vector< ValueType > &moduli)
	FerroelectricField (const Vector< ValueType > &moduli=Vector< ValueType >(), const SymmetryFlag &symmetry_flags=SymmetryFlag::null)
ewalena::Crystal::CrystalFieldBase < 3, 1, ValueType >	operator* () const
virtual	~FerroelectricField ()
Protected Member Functions
void	distribute_moduli_to_cubic ()
void	distribute_moduli_to_hexagonal ()

---

Detailed Description

template<typename ValueType = double>
class ewalena::Crystal::FerroelectricField< ValueType >

Ferroelectric field.

The ferroelectric tensor is a tensor.

Author:

Toby D. Young 2010, 2011.

---

Constructor & Destructor Documentation

template<typename ValueType = double>

ewalena::Crystal::FerroelectricField< ValueType >::FerroelectricField	(	const Vector< ValueType > &	moduli = Vector<ValueType> (),
		const SymmetryFlag &	symmetry_flags = SymmetryFlag::null
	)		[inline]

Constructor.

template<typename ValueType = double>

virtual ewalena::Crystal::FerroelectricField< ValueType >::~FerroelectricField

(

)

[virtual]

Virtual destructor.

---

Member Function Documentation

template<typename ValueType = double>

void ewalena::Crystal::FerroelectricField< ValueType >::distribute_moduli

(

const Vector< ValueType > &

moduli

)

[virtual]

Distribute moduli onto this tensor field according to rules governing the crystal group symmetry.

Reimplemented from ewalena::Crystal::CrystalFieldBase< 3, 1, ValueType >.

template<typename ValueType = double>

void ewalena::Crystal::FerroelectricField< ValueType >::distribute_moduli_to_cubic

(

)

[protected]

Distribute elastic moduli onto this tensor according to the rules governed by the cubic symmetry group.

template<typename ValueType = double>

void ewalena::Crystal::FerroelectricField< ValueType >::distribute_moduli_to_hexagonal

(

)

[protected]

Distribute elastic moduli onto this tensor according to the rules governed by the hexagonal symmetry group.

template<typename ValueType = double>

ewalena::Crystal::CrystalFieldBase<3, 1, ValueType> ewalena::Crystal::FerroelectricField< ValueType >::operator*

(

)

const [inline]

Access operator to the underlying tensor field base.

Reimplemented from ewalena::Crystal::CrystalFieldBase< 3, 1, ValueType >.

---

The documentation for this class was generated from the following file:

• include/ewalena/numerics/ferroelectric_field.h