PSCF v1.4.0
Pscf::Rpg::MaxOrderParameter< D > Class Template Reference

Evaluates maximum squared Fourier amplitude for W_{-} field. More...

#include <MaxOrderParameter.h>

Inheritance diagram for Pscf::Rpg::MaxOrderParameter< D >:
Pscf::Rp::MaxOrderParameter< D, Types< D > >

Public Member Functions

 MaxOrderParameter (Simulator< D > &simulator, System< D > &system)
 Constructor.
void setup () override
 Setup before the start of simulation.
Public Member Functions inherited from Pscf::Rp::MaxOrderParameter< D, Types< D > >
void setup () override
 Setup before simulation loop.

Protected Member Functions

double compute () override
 Compute and return the max order parameter.
Protected Member Functions inherited from Pscf::Rp::MaxOrderParameter< D, Types< D > >
 MaxOrderParameter (typename Types< D >::Simulator &simulator, typename Types< D >::System &system)
 Constructor.
 ~MaxOrderParameter ()=default
 Destructor.
void outputValue (int step, double value) override
 Output a sampled or block average value.
void computePsi ()
 Compute the psi_ array of squared Fourier coefficients.
void findMaximum (Array< typename Types< D >::Real > const &psi)
 Find the wavevector of maximum Fourier magnitude.

Additional Inherited Members

Protected Attributes inherited from Pscf::Rp::MaxOrderParameter< D, Types< D > >
Types< D >::RField psi_
 Square magnitude |W_|^2 in Fourier space.
double maxPsi_
 Maximum square magnitude (value of maximum element of psi_).
IntVec< D > Gmax_
 Indices of wavevector with maximum magnitude.
int kSize_
 Number of wavevectors in Fourier space (k-grid) mesh.

Detailed Description

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

Evaluates maximum squared Fourier amplitude for W_{-} field.

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

See also
Rp::MaxOrderParameter
Manual Page

Definition at line 41 of file /fts/analyzer/MaxOrderParameter.h.

Constructor & Destructor Documentation

◆ MaxOrderParameter()

template<int D>
Pscf::Rpg::MaxOrderParameter< D >::MaxOrderParameter ( Simulator< D > & simulator,
System< D > & system )

Constructor.

Parameters
simulatorparent simulator object
systemparent system object

Definition at line 33 of file MaxOrderParameter.cu.

References MaxOrderParameter().

Referenced by MaxOrderParameter().

Member Function Documentation

◆ setup()

template<int D>
void Pscf::Rpg::MaxOrderParameter< D >::setup ( )
override

◆ compute()


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