Pscf::Rp::SystemConstRef< D, T > Class Template Reference

Base class template for const access to an associated System. More...

#include <SystemConstRef.h>

Public Member Functions
T::System const &	system () const
	Get the associated System.
T::Mixture const &	mixture () const
	Get the Mixture.
T::Interaction const &	interaction () const
	Get the Interaction.
T::Domain const &	domain () const
	Get the Domain.
T::CFields const &	c () const
	Get the concentration (c) field container.
T::WFields const &	w () const
	Get the chemical potential (w) field container.
T::WFields const &	h () const
	Get the external potential (h) field container (if any).
T::Mask const &	mask () const
	Get the mask (if any).
FileMaster const &	fileMaster () const
	Get the FileMaster.

Protected Member Functions
	SystemConstRef ()
	Default constructor.
	SystemConstRef (typename T::System const &system)
	Constructor - creates associations.
	~SystemConstRef ()
	Destructor.
void	associate (typename T::System const &system)
	Create associations with a system and its components.

Detailed Description

template<int D, class T>
class Pscf::Rp::SystemConstRef< D, T >

Base class template for const access to an associated System.

A SystemConstRef holds read-only (const) pointers to an associated System object (type T::System) and several of its primary components, for a model with real fields and periodic boundary conditions. Accessor functions return the system and its components as const references.

Definition at line 33 of file system/SystemConstRef.h.

Constructor & Destructor Documentation

SystemConstRef() [1/2]

template<int D, class T>

Pscf::Rp::SystemConstRef< D, T >::SystemConstRef ( )

protected

Default constructor.

Definition at line 20 of file SystemConstRef.tpp.

SystemConstRef() [2/2]

template<int D, class T>

Pscf::Rp::SystemConstRef< D, T >::SystemConstRef ( typename T::System const & system )

protected

Constructor - creates associations.

Using of this constructor is equivalent to using the default constructor and then invoking the associate() function.

Parameters

system

parent system object

Definition at line 36 of file SystemConstRef.tpp.

References associate(), and system().

~SystemConstRef()

template<int D, class T>

Pscf::Rp::SystemConstRef< D, T >::~SystemConstRef ( )

protected

Destructor.

Definition at line 52 of file SystemConstRef.tpp.

Member Function Documentation

system()

template<int D, class T>

T::System const & Pscf::Rp::SystemConstRef< D, T >::system ( ) const

inline

Get the associated System.

Definition at line 41 of file system/SystemConstRef.h.

Referenced by associate(), and SystemConstRef().

mixture()

template<int D, class T>

T::Mixture const & Pscf::Rp::SystemConstRef< D, T >::mixture ( ) const

inline

Get the Mixture.

Definition at line 47 of file system/SystemConstRef.h.

interaction()

template<int D, class T>

T::Interaction const & Pscf::Rp::SystemConstRef< D, T >::interaction ( ) const

inline

Get the Interaction.

Definition at line 53 of file system/SystemConstRef.h.

domain()

template<int D, class T>

T::Domain const & Pscf::Rp::SystemConstRef< D, T >::domain ( ) const

inline

Get the Domain.

Definition at line 59 of file system/SystemConstRef.h.

c()

template<int D, class T>

T::CFields const & Pscf::Rp::SystemConstRef< D, T >::c ( ) const

inline

Get the concentration (c) field container.

Definition at line 65 of file system/SystemConstRef.h.

w()

template<int D, class T>

T::WFields const & Pscf::Rp::SystemConstRef< D, T >::w ( ) const

inline

Get the chemical potential (w) field container.

Definition at line 71 of file system/SystemConstRef.h.

h()

template<int D, class T>

T::WFields const & Pscf::Rp::SystemConstRef< D, T >::h ( ) const

inline

Get the external potential (h) field container (if any).

Definition at line 77 of file system/SystemConstRef.h.

mask()

template<int D, class T>

T::Mask const & Pscf::Rp::SystemConstRef< D, T >::mask ( ) const

inline

Get the mask (if any).

Definition at line 83 of file system/SystemConstRef.h.

fileMaster()

template<int D, class T>

FileMaster const & Pscf::Rp::SystemConstRef< D, T >::fileMaster ( ) const

inline

Get the FileMaster.

Definition at line 89 of file system/SystemConstRef.h.

associate()

template<int D, class T>

void Pscf::Rp::SystemConstRef< D, T >::associate ( typename T::System const & system )

protected

Create associations with a system and its components.

Parameters

system

parent system object

Definition at line 56 of file SystemConstRef.tpp.

References system().

Referenced by SystemConstRef().

---

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

• system/SystemConstRef.h
• SystemConstRef.tpp