Bridge++  Ver.2.1.3
Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
Action_F_Rational_SF Class Reference

action class for RHMC, with externally constructed Fopr_Rational. More...

#include <action_F_Rational_SF.h>

Inheritance diagram for Action_F_Rational_SF:
Action

Public Member Functions

 Action_F_Rational_SF (Fopr *fopr_langev, Fopr *fopr_H, Force *forceF_MD)
 constructor requires pointers to Fopr and Force instances. More...
 
 Action_F_Rational_SF (Fopr *fopr_langev, Fopr *fopr_H, Force *forceF_MD, const Parameters &params)
 
 ~Action_F_Rational_SF ()
 destructor. constructed instances are deconstructed in tydyup(). More...
 
void set_parameters (const Parameters &params)
 setting parameters and creating class instances. More...
 
void get_parameters (Parameters &params) const
 getting parameters More...
 
void set_label (const std::string label)
 set the label of action. More...
 
std::string get_label ()
 returns the label of action. More...
 
void set_config (Field *U)
 setting gauge configuration. More...
 
double langevin (RandomNumbers *)
 Langevin step called at the beginning of HMC. More...
 
double calcH ()
 calculation of Hamiltonian. More...
 
void force (Field &)
 returns force for updating conjugate momentum. More...
 
- Public Member Functions inherited from Action
 Action ()
 
virtual ~Action ()
 
virtual void force (Field &v, Field &U)
 

Static Public Attributes

static const std::string class_name = "Action_F_Rational_SF"
 

Private Member Functions

void init ()
 
void init (const Parameters &params)
 
void tidyup ()
 

Private Attributes

Bridge::VerboseLevel m_vl
 
std::string m_label
 
Fopr * m_fopr_langev
 
Fopr * m_fopr_H
 
Force * m_forceF_MD
 
Field * m_U
 
Field m_psf
 

Detailed Description

action class for RHMC, with externally constructed Fopr_Rational.

For the class, Fopr and Force objects are instantiated outside the class and specified at the construction. This class just provides the framework of rational actions. [28 Dec 2011 H.Matsufuru] unique_ptr is introduced to avoid memory leaks [21 Mar 2015 Y.Namekawa] Multi-threading applied. [01 Feb 2026 H.Matsufuru]

Definition at line 33 of file action_F_Rational_SF.h.

Constructor & Destructor Documentation

◆ Action_F_Rational_SF() [1/2]

Action_F_Rational_SF::Action_F_Rational_SF ( Fopr *  fopr_langev,
Fopr *  fopr_H,
Force *  forceF_MD 
)
inline

constructor requires pointers to Fopr and Force instances.

Definition at line 52 of file action_F_Rational_SF.h.

◆ Action_F_Rational_SF() [2/2]

Action_F_Rational_SF::Action_F_Rational_SF ( Fopr *  fopr_langev,
Fopr *  fopr_H,
Force *  forceF_MD,
const Parameters &  params 
)
inline

Definition at line 58 of file action_F_Rational_SF.h.

◆ ~Action_F_Rational_SF()

Action_F_Rational_SF::~Action_F_Rational_SF ( )
inline

destructor. constructed instances are deconstructed in tydyup().

Definition at line 66 of file action_F_Rational_SF.h.

Member Function Documentation

◆ calcH()

double Action_F_Rational_SF::calcH ( )
virtual

calculation of Hamiltonian.

Implements Action.

Definition at line 128 of file action_F_Rational_SF.cpp.

◆ force()

void Action_F_Rational_SF::force ( Field &  force)
virtual

returns force for updating conjugate momentum.

Implements Action.

Definition at line 160 of file action_F_Rational_SF.cpp.

◆ get_label()

std::string Action_F_Rational_SF::get_label ( )
inline

returns the label of action.

Definition at line 83 of file action_F_Rational_SF.h.

◆ get_parameters()

void Action_F_Rational_SF::get_parameters ( Parameters &  params) const
virtual

getting parameters

Implements Action.

Definition at line 69 of file action_F_Rational_SF.cpp.

◆ init() [1/2]

void Action_F_Rational_SF::init ( )
private

Definition at line 16 of file action_F_Rational_SF.cpp.

◆ init() [2/2]

void Action_F_Rational_SF::init ( const Parameters &  params)
private

Definition at line 34 of file action_F_Rational_SF.cpp.

◆ langevin()

double Action_F_Rational_SF::langevin ( RandomNumbers *  rand)
virtual

Langevin step called at the beginning of HMC.

Implements Action.

Definition at line 91 of file action_F_Rational_SF.cpp.

◆ set_config()

void Action_F_Rational_SF::set_config ( Field *  U)
virtual

setting gauge configuration.

Implements Action.

Definition at line 76 of file action_F_Rational_SF.cpp.

◆ set_label()

void Action_F_Rational_SF::set_label ( const std::string  label)
inline

set the label of action.

Definition at line 76 of file action_F_Rational_SF.h.

◆ set_parameters()

void Action_F_Rational_SF::set_parameters ( const Parameters &  params)
virtual

setting parameters and creating class instances.

Implements Action.

Definition at line 59 of file action_F_Rational_SF.cpp.

◆ tidyup()

void Action_F_Rational_SF::tidyup ( )
private

Definition at line 53 of file action_F_Rational_SF.cpp.

Member Data Documentation

◆ class_name

const std::string Action_F_Rational_SF::class_name = "Action_F_Rational_SF"
static

Definition at line 35 of file action_F_Rational_SF.h.

◆ m_fopr_H

Fopr* Action_F_Rational_SF::m_fopr_H
private

Definition at line 43 of file action_F_Rational_SF.h.

◆ m_fopr_langev

Fopr* Action_F_Rational_SF::m_fopr_langev
private

Definition at line 42 of file action_F_Rational_SF.h.

◆ m_forceF_MD

Force* Action_F_Rational_SF::m_forceF_MD
private

Definition at line 44 of file action_F_Rational_SF.h.

◆ m_label

std::string Action_F_Rational_SF::m_label
private

Definition at line 40 of file action_F_Rational_SF.h.

◆ m_psf

Field Action_F_Rational_SF::m_psf
private

Definition at line 48 of file action_F_Rational_SF.h.

◆ m_U

Field* Action_F_Rational_SF::m_U
private

Definition at line 46 of file action_F_Rational_SF.h.

◆ m_vl

Bridge::VerboseLevel Action_F_Rational_SF::m_vl
private

Definition at line 38 of file action_F_Rational_SF.h.

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