|
Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
|
User-facing API to build and query Wilson coefficients at matching and hadronic scales. More...
#include <WilsonInterface.h>
Public Member Functions | |
| WilsonInterface ()=default | |
| void | build (WilsonBuildConfig config) |
| Builds the full Wilson pipeline and makes queries available. | |
| void | addWilsonGroup (WilsonBuildConfig config) |
| Adds one or more Wilson groups to an existing built interface. | |
| WilsonInterface & | addCustomWilsonGroup (const CustomWilsonGroupConfig &config) |
| Register and initialize a runtime Wilson group described by lambdas. | |
| WilsonInterface & | add_custom_group (const CustomWilsonGroupConfig &config) |
| Snake-case alias for addCustomWilsonGroup. | |
| WilsonInterface & | addMatchingPatch (const WilsonMatchingPatch &patch) |
| Add an additive Wilson matching patch. | |
| WilsonInterface & | add_matching_patch (const WilsonMatchingPatch &patch) |
| Snake-case alias for addMatchingPatch. | |
| WilsonInterface & | addMatchingPatches (const std::vector< WilsonMatchingPatch > &patches) |
| Add several additive Wilson matching patches. | |
| void | set_matching_scale (double mu_W) |
| Sets the matching scale (mu_W) in the global parameter system. | |
| void | set_hadronic_scale (double mu_h) |
| Sets the hadronic scale (mu_h) in the global parameter system. | |
Matching-scale single coefficient accessors | |
The WGroup/WCoef overloads are kept for compatibility. The WGroupId/WCoefId overloads are the preferred dynamic API for runtime/config-driven code. | |
| scalar_t | getMatchingCoefficient (WGroupId group, WCoefId coeff, QCDOrder order, ContributionType cont_type) |
| Returns the matching-scale coefficient at the requested QCD order. | |
| scalar_t | getMatchingCoefficient (WGroup group, WCoef coeff, QCDOrder order, ContributionType cont_type) |
| Backward-compatible enum overload for builtin groups and coefficients. | |
| scalar_t | getM (WGroupId group, WCoefId coeff, QCDOrder order, ContributionType cont_type) |
| Alias for getMatchingCoefficient(WGroupId,WCoefId,QCDOrder,ContributionType). | |
| scalar_t | getM (WGroup group, WCoef coeff, QCDOrder order, ContributionType cont_type) |
| Backward-compatible enum alias. | |
| scalar_t | getFullMatchingCoefficient (WGroupId group, WCoefId coeff, QCDOrder order, ContributionType cont_type) |
Returns the matching coefficient with perturbative summation up to order. | |
| scalar_t | getFullMatchingCoefficient (WGroup group, WCoef coeff, QCDOrder order, ContributionType cont_type) |
| Backward-compatible enum overload for builtin groups and coefficients. | |
| scalar_t | getFM (WGroupId group, WCoefId coeff, QCDOrder order, ContributionType cont_type) |
| Alias for getFullMatchingCoefficient(WGroupId,WCoefId,QCDOrder,ContributionType). | |
| scalar_t | getFM (WGroup group, WCoef coeff, QCDOrder order, ContributionType cont_type) |
| Backward-compatible enum alias. | |
Hadronic-scale (running) single coefficient accessors | |
| scalar_t | getRunCoefficient (WGroupId group, WCoefId coeff, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Returns the hadronic/run coefficient at the requested order. | |
| scalar_t | getRunCoefficient (WGroup group, WCoef coeff, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Backward-compatible enum overload for builtin groups and coefficients. | |
| scalar_t | getR (WGroupId group, WCoefId coeff, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Alias for getRunCoefficient(WGroupId,WCoefId,QCDOrder,ContributionType,WilsonBasis). | |
| scalar_t | getR (WGroup group, WCoef coeff, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Backward-compatible enum alias. | |
| scalar_t | getFullRunCoefficient (WGroupId group, WCoefId coeff, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
Returns the full hadronic/run coefficient summed up to order. | |
| scalar_t | getFullRunCoefficient (WGroup group, WCoef coeff, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Backward-compatible enum overload for builtin groups and coefficients. | |
| scalar_t | getFR (WGroupId group, WCoefId coeff, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Alias for getFullRunCoefficient(WGroupId,WCoefId,QCDOrder,ContributionType,WilsonBasis). | |
| scalar_t | getFR (WGroup group, WCoef coeff, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Backward-compatible enum alias. | |
Convenience: per-order maps for a fixed coefficient | |
| std::map< QCDOrder, scalar_t > | getSepOrderMatchingCoefficient (WGroupId group, WCoefId coeff, ContributionType cont_type) |
| Returns a map {LO,NLO,NNLO} -> matching coefficient for a dynamic coefficient. | |
| std::map< QCDOrder, scalar_t > | getSepOrderMatchingCoefficient (WGroup group, WCoef coeff, ContributionType cont_type) |
| Backward-compatible enum overload. | |
| std::map< QCDOrder, scalar_t > | getSM (WGroupId group, WCoefId coeff, ContributionType cont_type) |
| Alias for getSepOrderMatchingCoefficient(WGroupId,WCoefId,ContributionType). | |
| std::map< QCDOrder, scalar_t > | getSM (WGroup group, WCoef coeff, ContributionType cont_type) |
| Backward-compatible enum alias. | |
| std::map< QCDOrder, scalar_t > | getSepOrderRunCoefficient (WGroupId group, WCoefId coeff, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Returns a map {LO,NLO,NNLO} -> hadronic coefficient for a dynamic coefficient. | |
| std::map< QCDOrder, scalar_t > | getSepOrderRunCoefficient (WGroup group, WCoef coeff, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Backward-compatible enum overload. | |
| std::map< QCDOrder, scalar_t > | getSR (WGroupId group, WCoefId coeff, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Alias for getSepOrderRunCoefficient(WGroupId,WCoefId,ContributionType,WilsonBasis). | |
| std::map< QCDOrder, scalar_t > | getSR (WGroup group, WCoef coeff, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Backward-compatible enum alias. | |
Convenience: full group maps (iterate all coefficients in the group) | |
| std::map< WCoef, scalar_t > | getAllMatchingCoefficients (WGroup group, QCDOrder order, ContributionType cont_type) |
| Returns {coef -> matching coefficient} for all coefficients in the group at a given order. | |
| std::map< WCoef, scalar_t > | getAM (WGroup group, QCDOrder order, ContributionType cont_type) |
| Alias for getAllMatchingCoefficients. | |
| std::map< WCoef, scalar_t > | getAllRunCoefficients (WGroup group, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Returns {coef -> hadronic coefficient} for all coefficients in the group at a given order and basis. | |
| std::map< WCoef, scalar_t > | getAR (WGroup group, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Alias for getAllRunCoefficients. | |
| std::map< WCoef, scalar_t > | getAllFullMatchingCoefficients (WGroup group, QCDOrder order, ContributionType cont_type) |
| Returns {coef -> full matching coefficient} (summed up to order) for all coefficients in the group. | |
| std::map< WCoef, scalar_t > | getAFM (WGroup group, QCDOrder order, ContributionType cont_type) |
| Alias for getAllFullMatchingCoefficients. | |
| std::map< WCoef, scalar_t > | getAllFullRunCoefficients (WGroup group, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Returns {coef -> full hadronic coefficient} (summed up to order) for all coefficients in the group. | |
| std::map< WCoef, scalar_t > | getAFR (WGroup group, QCDOrder order, ContributionType cont_type, WilsonBasis basis=WilsonBasis::B_STANDARD) |
| Alias for getAllFullRunCoefficients. | |
User-facing API to build and query Wilson coefficients at matching and hadronic scales.
This is the main entry point for end users. It provides:
1) Lifecycle:
2) Queries at MATCHING scale:
3) Queries at HADRONIC (running) scale:
4) Bulk convenience helpers:
Contribution semantics:
Backend / MARTY caveat:
Threading / mutability:
Typical usage:
Definition at line 76 of file WilsonInterface.h.
|
default |
| WilsonInterface & WilsonInterface::add_custom_group | ( | const CustomWilsonGroupConfig & | config | ) |
Snake-case alias for addCustomWilsonGroup.
Definition at line 50 of file WilsonInterface.cpp.
| WilsonInterface & WilsonInterface::add_matching_patch | ( | const WilsonMatchingPatch & | patch | ) |
Snake-case alias for addMatchingPatch.
Definition at line 64 of file WilsonInterface.cpp.
| WilsonInterface & WilsonInterface::addCustomWilsonGroup | ( | const CustomWilsonGroupConfig & | config | ) |
Register and initialize a runtime Wilson group described by lambdas.
This is the high-level entry point for user-defined Wilson coefficients. The caller registers/resolves dynamic ids with GroupMapper and WCoefMapper, fills a CustomWilsonGroupConfig with matching lambdas (and optional running lambdas), then passes it here.
If the interface has not been built yet, an empty Wilson pipeline is initialized first using the scales and order stored in config.
| config | Runtime/custom Wilson group configuration. |
*this for chaining.Definition at line 31 of file WilsonInterface.cpp.
| WilsonInterface & WilsonInterface::addMatchingPatch | ( | const WilsonMatchingPatch & | patch | ) |
Add an additive Wilson matching patch.
If called before build(), the patch is queued and applied as soon as the Wilson manager exists. Otherwise it is applied immediately.
Definition at line 54 of file WilsonInterface.cpp.
| WilsonInterface & WilsonInterface::addMatchingPatches | ( | const std::vector< WilsonMatchingPatch > & | patches | ) |
Add several additive Wilson matching patches.
Definition at line 68 of file WilsonInterface.cpp.
| void WilsonInterface::addWilsonGroup | ( | WilsonBuildConfig | config | ) |
Adds one or more Wilson groups to an existing built interface.
Requires build() to have been called first. Delegates to WilsonBuilder::add().
Definition at line 23 of file WilsonInterface.cpp.
| void WilsonInterface::build | ( | WilsonBuildConfig | config | ) |
Builds the full Wilson pipeline and makes queries available.
This constructs a WilsonBuilder with the provided config and retrieves the corresponding WilsonProvider.
After calling build(), all query methods become valid.
Definition at line 12 of file WilsonInterface.cpp.
| std::map< WCoef, scalar_t > WilsonInterface::getAFM | ( | WGroup | group, |
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Alias for getAllFullMatchingCoefficients.
Definition at line 277 of file WilsonInterface.cpp.
| std::map< WCoef, scalar_t > WilsonInterface::getAFR | ( | WGroup | group, |
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Alias for getAllFullRunCoefficients.
Definition at line 291 of file WilsonInterface.cpp.
| std::map< WCoef, scalar_t > WilsonInterface::getAllFullMatchingCoefficients | ( | WGroup | group, |
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Returns {coef -> full matching coefficient} (summed up to order) for all coefficients in the group.
Definition at line 267 of file WilsonInterface.cpp.
| std::map< WCoef, scalar_t > WilsonInterface::getAllFullRunCoefficients | ( | WGroup | group, |
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Returns {coef -> full hadronic coefficient} (summed up to order) for all coefficients in the group.
Definition at line 281 of file WilsonInterface.cpp.
| std::map< WCoef, scalar_t > WilsonInterface::getAllMatchingCoefficients | ( | WGroup | group, |
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Returns {coef -> matching coefficient} for all coefficients in the group at a given order.
Definition at line 239 of file WilsonInterface.cpp.
| std::map< WCoef, scalar_t > WilsonInterface::getAllRunCoefficients | ( | WGroup | group, |
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Returns {coef -> hadronic coefficient} for all coefficients in the group at a given order and basis.
Definition at line 253 of file WilsonInterface.cpp.
| std::map< WCoef, scalar_t > WilsonInterface::getAM | ( | WGroup | group, |
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Alias for getAllMatchingCoefficients.
Definition at line 249 of file WilsonInterface.cpp.
| std::map< WCoef, scalar_t > WilsonInterface::getAR | ( | WGroup | group, |
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Alias for getAllRunCoefficients.
Definition at line 263 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getFM | ( | WGroup | group, |
| WCoef | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Backward-compatible enum alias.
Definition at line 135 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getFM | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Alias for getFullMatchingCoefficient(WGroupId,WCoefId,QCDOrder,ContributionType).
Definition at line 131 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getFR | ( | WGroup | group, |
| WCoef | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Backward-compatible enum alias.
Definition at line 193 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getFR | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Alias for getFullRunCoefficient(WGroupId,WCoefId,QCDOrder,ContributionType,WilsonBasis).
Definition at line 189 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getFullMatchingCoefficient | ( | WGroup | group, |
| WCoef | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Backward-compatible enum overload for builtin groups and coefficients.
Definition at line 127 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getFullMatchingCoefficient | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Returns the matching coefficient with perturbative summation up to order.
Dynamic-id overload. The summation convention is implemented in the manager: C_full = Sum_{n=LO..order} C^{(n)} * (alpha_s(mu_W)/(4*pi))^(n-1).
Definition at line 111 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getFullRunCoefficient | ( | WGroup | group, |
| WCoef | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Backward-compatible enum overload for builtin groups and coefficients.
Definition at line 185 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getFullRunCoefficient | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Returns the full hadronic/run coefficient summed up to order.
Dynamic-id overload. The summation convention is implemented in the manager: C_full = Sum_{n=LO..order} C^{(n)} * (alpha_s(mu_b)/(4*pi))^(n-1).
Definition at line 168 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getM | ( | WGroup | group, |
| WCoef | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Backward-compatible enum alias.
Definition at line 107 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getM | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Alias for getMatchingCoefficient(WGroupId,WCoefId,QCDOrder,ContributionType).
Definition at line 103 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getMatchingCoefficient | ( | WGroup | group, |
| WCoef | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Backward-compatible enum overload for builtin groups and coefficients.
Definition at line 99 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getMatchingCoefficient | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type | ||
| ) |
Returns the matching-scale coefficient at the requested QCD order.
Dynamic-id overload. This avoids converting through the legacy static enum and allows callers to resolve names with GroupMapper::id_of() and WCoefMapper::id_of().
Definition at line 83 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getR | ( | WGroup | group, |
| WCoef | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Backward-compatible enum alias.
Definition at line 164 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getR | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Alias for getRunCoefficient(WGroupId,WCoefId,QCDOrder,ContributionType,WilsonBasis).
Definition at line 160 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getRunCoefficient | ( | WGroup | group, |
| WCoef | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Backward-compatible enum overload for builtin groups and coefficients.
Definition at line 156 of file WilsonInterface.cpp.
| scalar_t WilsonInterface::getRunCoefficient | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| QCDOrder | order, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Returns the hadronic/run coefficient at the requested order.
Dynamic-id overload. basis selects the hadronic Wilson basis.
Definition at line 139 of file WilsonInterface.cpp.
| std::map< QCDOrder, scalar_t > WilsonInterface::getSepOrderMatchingCoefficient | ( | WGroup | group, |
| WCoef | coeff, | ||
| ContributionType | cont_type | ||
| ) |
Backward-compatible enum overload.
Definition at line 206 of file WilsonInterface.cpp.
| std::map< QCDOrder, scalar_t > WilsonInterface::getSepOrderMatchingCoefficient | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| ContributionType | cont_type | ||
| ) |
Returns a map {LO,NLO,NNLO} -> matching coefficient for a dynamic coefficient.
Definition at line 197 of file WilsonInterface.cpp.
| std::map< QCDOrder, scalar_t > WilsonInterface::getSepOrderRunCoefficient | ( | WGroup | group, |
| WCoef | coeff, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Backward-compatible enum overload.
Definition at line 227 of file WilsonInterface.cpp.
| std::map< QCDOrder, scalar_t > WilsonInterface::getSepOrderRunCoefficient | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Returns a map {LO,NLO,NNLO} -> hadronic coefficient for a dynamic coefficient.
Definition at line 218 of file WilsonInterface.cpp.
| std::map< QCDOrder, scalar_t > WilsonInterface::getSM | ( | WGroup | group, |
| WCoef | coeff, | ||
| ContributionType | cont_type | ||
| ) |
Backward-compatible enum alias.
Definition at line 214 of file WilsonInterface.cpp.
| std::map< QCDOrder, scalar_t > WilsonInterface::getSM | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| ContributionType | cont_type | ||
| ) |
Alias for getSepOrderMatchingCoefficient(WGroupId,WCoefId,ContributionType).
Definition at line 210 of file WilsonInterface.cpp.
| std::map< QCDOrder, scalar_t > WilsonInterface::getSR | ( | WGroup | group, |
| WCoef | coeff, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Backward-compatible enum alias.
Definition at line 235 of file WilsonInterface.cpp.
| std::map< QCDOrder, scalar_t > WilsonInterface::getSR | ( | WGroupId | group, |
| WCoefId | coeff, | ||
| ContributionType | cont_type, | ||
| WilsonBasis | basis = WilsonBasis::B_STANDARD |
||
| ) |
Alias for getSepOrderRunCoefficient(WGroupId,WCoefId,ContributionType,WilsonBasis).
Definition at line 231 of file WilsonInterface.cpp.
| void WilsonInterface::set_hadronic_scale | ( | double | mu_h | ) |
Sets the hadronic scale (mu_h) in the global parameter system.
This updates the value of the scale parameter corresponding to ScaleType::HADRONIC. It does not automatically rebuild/combine blocks; dependent blocks will update on demand.
Definition at line 79 of file WilsonInterface.cpp.
| void WilsonInterface::set_matching_scale | ( | double | mu_W | ) |
Sets the matching scale (mu_W) in the global parameter system.
This updates the value of the scale parameter corresponding to ScaleType::MATCHING. It does not automatically rebuild/combine blocks; dependent blocks will update on demand.
Definition at line 75 of file WilsonInterface.cpp.