Base class for nuclear form factor models. More...

#include <NuclearFormFactor.hh>

Inheritance diagram for marley::NuclearFormFactor:

Public Member Functions
	NuclearFormFactor (int Z, int A)

int	A () const

virtual double	F (double kappa) const =0

int	Z () const

Static Public Member Functions
static std::shared_ptr< marley::NuclearFormFactor >	create (int Z, int A, const JSON &ff_config)

Protected Attributes
int	A_
	Nucleon number.

int	Z_
	Proton number.

Detailed Description

Base class for nuclear form factor models.

Definition at line 33 of file NuclearFormFactor.hh.

Constructor & Destructor Documentation

◆ NuclearFormFactor()

marley::NuclearFormFactor::NuclearFormFactor	(	int	Z,
		int	A )

inline

Parameters

Z	Proton number
A	Nucleon number

Definition at line 38 of file NuclearFormFactor.hh.

38: Z_( Z ), A_( A ) {}

marley::NuclearFormFactor::Z_

int Z_

Proton number.

Definition NuclearFormFactor.hh:60

marley::NuclearFormFactor::A_

int A_

Nucleon number.

Definition NuclearFormFactor.hh:63

References A_, and Z_.

Member Function Documentation

◆ A()

int marley::NuclearFormFactor::A ( ) const

inline

Definition at line 47 of file NuclearFormFactor.hh.

47{ return A_; }

◆ create()

std::shared_ptr< marley::NuclearFormFactor > marley::NuclearFormFactor::create	(	int	Z,
		int	A,
		const JSON &	ff_config )

static

Factory method to create derived class objects

Parameters

Z	Proton number
A	Nucleon number
ff_config	JSON object containing the model configuration to use when initializing the new object

Definition at line 24 of file NuclearFormFactor.cc.

{
  static bool need_to_log_nuc_ff_info = true;
 
  // If the user has requested use of the allowed approximation, then configure
  // the trivial nuclear form factor model and return without logging this
  // choice (it will be handled elsewhere)
  if ( marley::JSONConfig::check_for_allowed_approximation(ff_config) ) {
    auto tnff = std::make_shared< marley::TrivialNuclearFormFactor >( Z, A );
    need_to_log_nuc_ff_info = false;
    return tnff;
  }
 
  if ( !ff_config.has_key("nuclear_model") ) {
    throw marley::Error( "Missing nuclear form factor model configuration" );
  }
  const auto& nucl_json = ff_config.at( "nuclear_model" );
  if ( !nucl_json.is_string() ) {
    throw marley::Error( "Invalid nuclear form factor model "
      + nucl_json.dump_string() );
  }
  std::string nucl_ff_model = nucl_json.to_string();
 
  std::shared_ptr< marley::NuclearFormFactor > nuclear_ff;
 
  // Choose the model to use for the nuclear form factor
  if ( nucl_ff_model == "trivial" ) {
    nuclear_ff = std::make_shared< marley::TrivialNuclearFormFactor >( Z, A );
    if ( need_to_log_nuc_ff_info ) {
      MARLEY_LOG( INFO, "physics.formfactor" ) << "Using trivial nuclear form factor";
    }
  }
  else if ( nucl_ff_model == "helm" ) {
    nuclear_ff = std::make_shared< marley::HelmNuclearFormFactor >( Z, A );
    if ( need_to_log_nuc_ff_info ) {
      MARLEY_LOG( INFO, "physics.formfactor" ) << "Using Helm nuclear form factor";
    }
  }
  else if ( nucl_ff_model == "klein" ) {
 
    // Retrieve the optional "nucl_options" JSON object if it is present
    bool ok; // dummy flag used when parsing the JSON configuration
    marley::JSON nucl_opt = assign_from_json< marley::JSON >(
      "nucl_options", ff_config, ok, marley::JSON::object() );
 
    // Set the "adapted" option from the parameters if it is present
    bool adapted = assign_from_json< bool >( "adapted", nucl_opt, ok, true );
 
    nuclear_ff = std::make_shared< marley
      ::KleinNystrandNuclearFormFactor >( Z, A, adapted );
 
    if ( need_to_log_nuc_ff_info ) {
      std::string kn_name;
      if ( adapted ) kn_name += "adapted ";
      kn_name += "Klein-Nystrand";
      MARLEY_LOG( INFO, "physics.formfactor" ) << "Using " << kn_name << " nuclear form factor";
    }
  }
  else throw marley::Error( "Unrecognized nuclear form factor model name \""
    + nucl_ff_model + "\" in marley::NuclearFormFactor::create()" );
 
  need_to_log_nuc_ff_info = false;
  return nuclear_ff;
}