Pscf::Rpg::FilmEnvironment< D > Class Template Reference

Class defining mask & external fields for thin-film systems. More...

#include <FilmEnvironment.h>

Inheritance diagram for Pscf::Rpg::FilmEnvironment< D >:

Public Member Functions
	FilmEnvironment (System< D > &sys)
	Constructor.
	~FilmEnvironment ()
	Destructor.
Public Member Functions inherited from Pscf::Prdc::MixAndMatchEnv
	MixAndMatchEnv ()
	Constructor.
	~MixAndMatchEnv ()
	Destructor.
double	modifyStress (int paramId, double stress) const
	Modify stress to account for Environment, for one lattice parameter.
Public Member Functions inherited from Pscf::MixAndMatchEnvTmpl< Environment, FieldGenerator >
	MixAndMatchEnvTmpl ()
	Constructor.
	~MixAndMatchEnvTmpl ()
	Destructor.
void	readParameters (std::istream &in)
	Read parameters from input stream.
void	generate ()
	Checks if fields need to be (re)generated.
FieldGenerator const &	fieldGenerator1 () const
	Get the first FieldGenerator by const reference.
FieldGenerator const &	fieldGenerator2 () const
	Get the second FieldGenerator (if any) by const reference.
bool	hasFieldGenerator2 () const
	Does a second FieldGenerator exist?
GArray< ParameterType >	getParameterTypes ()
	Get specialized sweep parameter types to add to a Sweep object.

Additional Inherited Members
Protected Attributes inherited from Pscf::MixAndMatchEnvTmpl< Environment, FieldGenerator >
FieldGenerator *	fieldGenPtr1_
	Pointer to the first FieldGenerator object (required).
FieldGenerator *	fieldGenPtr2_
	Pointer to the second FieldGenerator object (optional).

Detailed Description

template<int D>
class Pscf::Rpg::FilmEnvironment< D >

Class defining mask & external fields for thin-film systems.

Definition at line 30 of file rpg/environment/FilmEnvironment.h.

Constructor & Destructor Documentation

FilmEnvironment()

template<int D>

Pscf::Rpg::FilmEnvironment< D >::FilmEnvironment ( System< D > & sys )

inline

Constructor.

Parameters

sys	System parent object

Definition at line 40 of file rpg/environment/FilmEnvironment.h.

References Pscf::Prdc::MixAndMatchEnv::MixAndMatchEnv(), and Util::ParamComposite::setClassName().

~FilmEnvironment()

template<int D>

Pscf::Rpg::FilmEnvironment< D >::~FilmEnvironment ( )

inline

Destructor.

Definition at line 48 of file rpg/environment/FilmEnvironment.h.

---

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

• rpg/environment/FilmEnvironment.h