GM2Calc 2.3.0
Loading...
Searching...
No Matches
Namespaces | Functions
THDM_c.cpp File Reference

contains definitions of C interface functions for the model More...

Go to the source code of this file.

Namespaces

namespace  gm2calc
 

Functions

gm2calc_THDM_yukawa_type int_to_c_yukawa_type (int i)
 convert int to gm2calc_THDM_yukawa_type
 
void gm2calc_thdm_config_set_to_default (gm2calc_THDM_config *config)
 Sets configuration options to default values.
 
gm2calc_error gm2calc_thdm_new_with_gauge_basis (gm2calc_THDM **model, const gm2calc_THDM_gauge_basis *basis, const ::gm2calc_SM *sm, const gm2calc_THDM_config *config)
 Allocate a new general THDM model with general basis input.
 
gm2calc_error gm2calc_thdm_new_with_mass_basis (gm2calc_THDM **model, const gm2calc_THDM_mass_basis *basis, const ::gm2calc_SM *sm, const gm2calc_THDM_config *config)
 Allocate a new general THDM model with physical basis input.
 
void gm2calc_thdm_free (gm2calc_THDM *model)
 Deletes a general THDM model.
 

Detailed Description

contains definitions of C interface functions for the model

This file contains the definitions for the C interface functions used to set and retrieve the model parameters and masses.

Definition in file THDM_c.cpp.

Function Documentation

◆ gm2calc_thdm_config_set_to_default()

void gm2calc_thdm_config_set_to_default ( gm2calc_THDM_config config)

Sets configuration options to default values.

create a new config

Parameters
configpointer to configuration options

Definition at line 178 of file THDM_c.cpp.

◆ gm2calc_thdm_free()

void gm2calc_thdm_free ( gm2calc_THDM model)

Deletes a general THDM model.

delete general THDM model

This function deletes a general THDM model object, which has been created using gm2calc_thdm_new() .

Parameters
modelpointer to model object

Definition at line 279 of file THDM_c.cpp.

◆ gm2calc_thdm_new_with_gauge_basis()

gm2calc_error gm2calc_thdm_new_with_gauge_basis ( gm2calc_THDM **  model,
const gm2calc_THDM_gauge_basis basis,
const ::gm2calc_SM sm,
const gm2calc_THDM_config config 
)

Allocate a new general THDM model with general basis input.

This function allocates a new general THDM model and sets the pointer to the created object. To prevent a resource leak, the model should be destroyed using gm2calc_thdm_free() .

If an error occurs, the model pointer will be set to 0 and a corresponding error code will be returned.

Returns
error code

Definition at line 199 of file THDM_c.cpp.

◆ gm2calc_thdm_new_with_mass_basis()

gm2calc_error gm2calc_thdm_new_with_mass_basis ( gm2calc_THDM **  model,
const gm2calc_THDM_mass_basis basis,
const ::gm2calc_SM sm,
const gm2calc_THDM_config config 
)

Allocate a new general THDM model with physical basis input.

This function allocates a new general THDM model and sets the pointer to the created object. To prevent a resource leak, the model should be destroyed using gm2calc_thdm_free() .

If an error occurs, the model pointer will be set to 0 and a corresponding error code will be returned.

Returns
error code

Definition at line 241 of file THDM_c.cpp.

◆ int_to_c_yukawa_type()

gm2calc_THDM_yukawa_type int_to_c_yukawa_type ( int  i)

convert int to gm2calc_THDM_yukawa_type

Definition at line 158 of file THDM_c.cpp.