PSCF v1.4.0
Pscf::Rpc::SystemConstRef< D > Class Template Reference

Const access to a System. More...

#include <SystemConstRef.h>

Inheritance diagram for Pscf::Rpc::SystemConstRef< D >:
Pscf::Rp::SystemConstRef< D, Types< D > >

Public Member Functions

 SystemConstRef ()
 Default constructor.
 SystemConstRef (System< D > const &system)
 Constructor.
virtual ~SystemConstRef ()=default
 Destructor.
Public Member Functions inherited from Pscf::Rp::SystemConstRef< D, Types< D > >
Types< D >::System const & system () const
 Get the associated System.
Types< D >::Mixture const & mixture () const
 Get the Mixture.
Types< D >::Interaction const & interaction () const
 Get the Interaction.
Types< D >::Domain const & domain () const
 Get the Domain.
Types< D >::CFields const & c () const
 Get the concentration (c) field container.
Types< D >::WFields const & w () const
 Get the chemical potential (w) field container.
Types< D >::WFields const & h () const
 Get the external potential (h) field container (if any).
Types< D >::Mask const & mask () const
 Get the mask (if any).
FileMaster const & fileMaster () const
 Get the FileMaster.

Additional Inherited Members

Protected Member Functions inherited from Pscf::Rp::SystemConstRef< D, Types< D > >
 SystemConstRef ()
 Default constructor.
 ~SystemConstRef ()
 Destructor.
void associate (typename Types< D >::System const &system)
 Create associations with a system and its components.

Detailed Description

template<int D>
class Pscf::Rpc::SystemConstRef< D >

Const access to a System.

Specializations of this template with D=1, 2, and 3 are derived from corresponding specializations of the base class template Rp::SystemConstRef, and inherit their public interface and almost all of their source code from this base class.

See also
Rp::SystemConstRef

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

Constructor & Destructor Documentation

◆ SystemConstRef() [1/2]

template<int D>
Pscf::Rpc::SystemConstRef< D >::SystemConstRef ( )
inline

Default constructor.

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

References SystemConstRef().

Referenced by SystemConstRef(), and SystemConstRef().

◆ SystemConstRef() [2/2]

template<int D>
Pscf::Rpc::SystemConstRef< D >::SystemConstRef ( System< D > const & system)
inline

Constructor.

Parameters
systemSystem<D> object to which this refers.

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

References Pscf::Rp::SystemConstRef< D, Types< D > >::system(), and SystemConstRef().

◆ ~SystemConstRef()

template<int D>
virtual Pscf::Rpc::SystemConstRef< D >::~SystemConstRef ( )
virtualdefault

Destructor.


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