NcHIPertFirstOrder: NumCosmo Reference Manual

NcHIPertFirstOrder

NcHIPertFirstOrder — Base object for implementing first order perturbation in a Friedmann background.

Functions

NcHIPertFirstOrder *	nc_hipert_first_order_new ()
NcHIPertFirstOrder *	nc_hipert_first_order_new_full ()
NcHIPertFirstOrder *	nc_hipert_first_order_ref ()
void	nc_hipert_first_order_free ()
void	nc_hipert_first_order_clear ()
void	nc_hipert_first_order_set_gauge ()
NcHIPertGravGauge	nc_hipert_first_order_get_gauge ()
void	nc_hipert_first_order_set_reltol ()
void	nc_hipert_first_order_set_abstol ()
gdouble	nc_hipert_first_order_get_reltol ()
gdouble	nc_hipert_first_order_get_abstol ()
void	nc_hipert_first_order_set_integ ()
NcHIPertFirstOrderInteg	nc_hipert_first_order_get_integ ()
void	nc_hipert_first_order_set_grav ()
NcHIPertGrav *	nc_hipert_first_order_get_grav ()
NcHIPertGrav *	nc_hipert_first_order_peek_grav ()
void	nc_hipert_first_order_add_comp ()
void	nc_hipert_first_order_prepare ()

Properties

double	abstol	Read / Write / Construct
NcmObjArray *	comp-array	Read / Write / Construct
NcDistance *	distance	Read / Write / Construct
NcHIPertGravGauge	gauge	Read / Write / Construct
NcHIPertGrav *	grav	Read / Write / Construct
NcHIPertFirstOrderInteg	integ	Read / Write / Construct
NcRecomb *	recomb	Read / Write / Construct
double	reltol	Read / Write / Construct
NcScalefactor *	scalefactor	Read / Write / Construct

Types and Values

enum	NcHIPertFirstOrderInteg

Object Hierarchy

    GEnum
    ╰── NcHIPertFirstOrderInteg
    GObject
    ╰── NcHIPert
        ╰── NcHIPertBoltzmann
            ╰── NcHIPertFirstOrder

Description

FIXME

Functions

nc_hipert_first_order_new ()

NcHIPertFirstOrder *
nc_hipert_first_order_new (void);

Creates a new NcHIPertFirstOrder.

Returns

the newly instantiated NcHIPertFirstOrder.

[transfer full]

nc_hipert_first_order_new_full ()

NcHIPertFirstOrder *
nc_hipert_first_order_new_full (NcDistance *dist,
                                NcRecomb *recomb,
                                NcScalefactor *a);

Creates a new NcHIPertFirstOrder.

Parameters

dist	a NcDistance
recomb	a NcRecomb
a	a NcScalefactor

Returns

the newly instantiated NcHIPertFirstOrder.

[transfer full]

nc_hipert_first_order_ref ()

NcHIPertFirstOrder *
nc_hipert_first_order_ref (NcHIPertFirstOrder *fo);

Increases the reference count of fo .

Parameters

a NcHIPertFirstOrder

Returns

fo .

[transfer full]

nc_hipert_first_order_free ()

void
nc_hipert_first_order_free (NcHIPertFirstOrder *fo);

Decreases the reference count of fo .

Parameters

a NcHIPertFirstOrder

nc_hipert_first_order_clear ()

void
nc_hipert_first_order_clear (NcHIPertFirstOrder **fo);

Decreases the reference count of *fo and sets the pointer *fo to NULL.

Parameters

a NcHIPertFirstOrder

nc_hipert_first_order_set_gauge ()

void
nc_hipert_first_order_set_gauge (NcHIPertFirstOrder *fo,
                                 NcHIPertGravGauge gauge);

Sets the gauge to be used in the first order system.

Parameters

fo	a NcHIPertFirstOrder
gauge	a NcHIPertGravGauge

nc_hipert_first_order_get_gauge ()

NcHIPertGravGauge
nc_hipert_first_order_get_gauge (NcHIPertFirstOrder *fo);

Gets the gauge used by fo .

Parameters

a NcHIPertFirstOrder

Returns

the gauge used by fo

nc_hipert_first_order_set_reltol ()

void
nc_hipert_first_order_set_reltol (NcHIPertFirstOrder *fo,
                                  const gdouble reltol);

Sets the relative tolerance to reltol .

Parameters

fo	a NcHIPertFirstOrder
reltol	relative tolerance used during the integration

nc_hipert_first_order_set_abstol ()

void
nc_hipert_first_order_set_abstol (NcHIPertFirstOrder *fo,
                                  const gdouble abstol);

Sets the absolute tolerance to abstol .

Parameters

fo	a NcHIPertFirstOrder
abstol	absolute tolerance used during the integration

nc_hipert_first_order_get_reltol ()

gdouble
nc_hipert_first_order_get_reltol (NcHIPertFirstOrder *fo);

Gets the relative tolerance.

Parameters

a NcHIPertFirstOrder

Returns

the current relative tolerance.

nc_hipert_first_order_get_abstol ()

gdouble
nc_hipert_first_order_get_abstol (NcHIPertFirstOrder *fo);

Gets the absolute tolerance.

Parameters

a NcHIPertFirstOrder

Returns

the current absolute tolerance.

nc_hipert_first_order_set_integ ()

void
nc_hipert_first_order_set_integ (NcHIPertFirstOrder *fo,
                                 NcHIPertFirstOrderInteg integ);

Sets the integrator to be used.

Parameters

fo	a NcHIPertFirstOrder
integ	integrator type NcHIPertFirstOrderInteg

nc_hipert_first_order_get_integ ()

NcHIPertFirstOrderInteg
nc_hipert_first_order_get_integ (NcHIPertFirstOrder *fo);

Gets the integrator used.

Parameters

a NcHIPertFirstOrder

Returns

the current integrator used by fo .

nc_hipert_first_order_set_grav ()

void
nc_hipert_first_order_set_grav (NcHIPertFirstOrder *fo,
                                NcHIPertGrav *grav);

Sets the gravitation object.

Parameters

fo	a NcHIPertFirstOrder
grav	a NcHIPertGrav

nc_hipert_first_order_get_grav ()

NcHIPertGrav *
nc_hipert_first_order_get_grav (NcHIPertFirstOrder *fo);

Gets the gravitation NcHIPertGrav object.

Parameters

a NcHIPertFirstOrder

Returns

the NcHIPertGrav object used by fo .

[transfer full][nullable]

nc_hipert_first_order_peek_grav ()

NcHIPertGrav *
nc_hipert_first_order_peek_grav (NcHIPertFirstOrder *fo);

Peeks the NcHIPertGrav object.

Parameters

a NcHIPertFirstOrder

Returns

the NcHIPertGrav object used by fo .

[transfer none][nullable]

nc_hipert_first_order_add_comp ()

void
nc_hipert_first_order_add_comp (NcHIPertFirstOrder *fo,
                                NcHIPertComp *comp);

Adds a new component comp to the system.

Parameters

fo	a NcHIPertFirstOrder
comp	a NcHIPertComp

nc_hipert_first_order_prepare ()

void
nc_hipert_first_order_prepare (NcHIPertFirstOrder *fo,
                               NcHICosmo *cosmo);

Adds a new component comp to the system.

Parameters

fo	a NcHIPertFirstOrder
cosmo	a NcHICosmo

Types and Values

enum NcHIPertFirstOrderInteg

ODE integrators.

Members

NC_HIPERT_FIRST_ORDER_INTEG_CVODE	CVode integrator
NC_HIPERT_FIRST_ORDER_INTEG_ARKODE	ARKode integrator

Property Details

The `“abstol”` property

  “abstol”                   double

Absolute tolerance tolerance.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 0

The `“comp-array”` property

  “comp-array”               NcmObjArray *

Components array.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct

The `“distance”` property

  “distance”                 NcDistance *

Distance object.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct

The `“gauge”` property

  “gauge”                    NcHIPertGravGauge

Gauge.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct

Default value: NC_HIPERT_GRAV_GAUGE_SYNCHRONOUS

The `“grav”` property

  “grav”                     NcHIPertGrav *

Gravitation object.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct

The `“integ”` property

  “integ”                    NcHIPertFirstOrderInteg

ODE integrator.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct

Default value: NC_HIPERT_FIRST_ORDER_INTEG_ARKODE

The `“recomb”` property

  “recomb”                   NcRecomb *

Recombination object.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct

The `“reltol”` property

  “reltol”                   double

Relative tolerance.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct

Allowed values: [0,1]

Default value: 1e-07

The `“scalefactor”` property

  “scalefactor”              NcScalefactor *

Scale factor object.

Owner: NcHIPertFirstOrder

Flags: Read / Write / Construct