auxoptions(3)

📦
version 1.1.2 · 3 versions
, in fedora 43

💖 auxoptions — Auxiliary Options 💖

okay bestie, welcome to the auxoptions(3) page of the MEPACK manual ✨ this one's a lil grab-bag of helper stuff — the auxiliary options for OpenMP and verbosity. no cap, it's giving "miscellaneous but essential" 💅

🌸 NAME 🌸

auxoptions — Auxiliary Options

  • Auxiliary Options for OpenMP and verbosity. that's the whole vibe 🫶

✨ SYNOPSIS ✨

🎀 Modules

  • module mepack_options_openmp — Enable/Disable to use of OpenMP accelerated routines.
  • module mepack_options_verbose — Control the verbosity of MEPACK.

🦋 Functions/Subroutines

  • int mepack_openmp_enabled (void) — Return if the OpenMP accelerated subroutines are enabled.
  • void mepack_openmp_enable (int openmp) — Enable or disable the OpenMP accelerated solvers.
  • integer function mepack_options_openmp::openmp_enabled () — Return if OpenMP is enabled.
  • subroutine mepack_options_openmp::openmp_enable (openmp) — Enable or disable the use of OpenMP accelerated routines.
  • void mepack_verbose_init (void) — C Interface for MEPACK_OPTIONS_VERBOSE::VERBOSE_INIT.
  • void mepack_verbose_set (int level) — C Interface for MEPACK_OPTIONS_VERBOSE::VERBOSE_SET.
  • int mepack_verbose_get (void) — C Interface for MEPACK_OPTIONS_VERBOSE::VERBOSE_GET.
  • subroutine mepack_options_verbose::verbose_init () — Initializes the module.
  • subroutine mepack_options_verbose::verbose_set (level) — Set the verbosity level of MEPACK.
  • integer function mepack_options_verbose::verbose_get () — Returns the current verbosity level of MEPACK.

🌈 Detailed Description 🌈

Auxiliary Options for OpenMP and verbosity.

This section contains auxiliary routines that do not fit in one of the other categories. like, they're the little side characters that still ate, fr fr 👑

👑 Function/Subroutine Documentation 👑

💜 void mepack_openmp_enable (int openmp)

Enable or disable the OpenMP accelerated solvers.

Parameters

  • openmp — Boolean integer value to enable or disable the OpenMP accelerated solvers.

The mepack_openmp_enable function enables or disables the OpenMP accelerated subroutines.

Definition at line 50 of file openmp.c.

💜 int mepack_openmp_enabled (void )

Return if the OpenMP accelerated subroutines are enabled.

Returns

  • A non-zero if the OpenMP accelerated subroutines are enabled.

The mepack_openmp_enabled function returns a true value if the OpenMP accelerated subroutines are used. This is beneficial in MATLAB if the OpenMP accelerated solvers cause MATLAB to crash. 😭 (yes, crash-prevention, we love a safety girlie)

Definition at line 36 of file openmp.c.

💜 int mepack_verbose_get (void )

C Interface for MEPACK_OPTIONS_VERBOSE::VERBOSE_GET.

Returns

  • The current verbosity level of MEPACK

The mepack_verbose_get function is a wrapper around MEPACK_OPTIONS_VERBOSE::VERBOSE_GET. It returns the current verbosity level of MEPACK.

See also

  • mepack_options_verbose::verbose_get

Definition at line 64 of file verbose.c.

💜 void mepack_verbose_init (void )

C Interface for MEPACK_OPTIONS_VERBOSE::VERBOSE_INIT. The mepack_verbose_init function wraps the Fortran subroutine MEPACK_OPTIONS_VERBOSE::VERBOSE_INIT such that it can be called from C easily.

See also

  • mepack_options_verbose::verbose_init

Definition at line 36 of file verbose.c.

💜 void mepack_verbose_set (int level)

C Interface for MEPACK_OPTIONS_VERBOSE::VERBOSE_SET.

Parameters

  • level — New verbosity level

The mepack_verbose_set function is a wrapper around MEPACK_OPTIONS_VERBOSE::VERBOSE_SET. It set the verbosity level of MEPACK.

See also

  • mepack_options_verbose::verbose_set

Definition at line 50 of file verbose.c.

💜 subroutine mepack_options_openmp::openmp_enable (integer, intent(in) openmp)

Enable or disable the use of OpenMP accelerated routines.

Parameters

  • OPENMP — Integer identifying if OpenMP is enabled or not.

The OPENMP_ENABLE function enables or disables the use of OpenMP in the automatic solver selection. If the OpenMP solver gets selected and OpenMP is not allowed, the standard level-3 solver is used. This can be beneficial in MATLAB if the OpenMP routines crash.

Definition at line 54 of file openmp.f90.

💜 integer function mepack_options_openmp::openmp_enabled

Return if OpenMP is enabled.

Returns

  • A non zero value if OpenMP is enabled.

The OPENMP_ENABLED function returns a non zero value if the OpenMP accelerated solvers should be used. This only influences the automatic solver selection. (only the automatic selection, bestie — don't @ it for anything else 🙈)

Definition at line 39 of file openmp.f90.

💜 integer function mepack_options_verbose::verbose_get

Returns the current verbosity level of MEPACK.

Returns

  • Integer value defining the current verbosity level.

The VERBOSE_GET function returns the current verbosity level. Zero means nothing should be written to the screen. Everything non-zero is interpreted as print some information on the screen.

so like, 0 = silence, anything else = MEPACK starts yapping 🗣️ iconic behavior tbh

Definition at line 73 of file verbose.f90.

💜 subroutine mepack_options_verbose::verbose_init

Initializes the module. The VERBOSE_INIT subroutine is automatically called when MEPACK is initialized. It reads the MEPACK_VERBOSE environment variable and set the internal verbosity state accordingly.

See also

  • mepack_options_verbose::verbose_set

Definition at line 39 of file verbose.f90.

💜 subroutine mepack_options_verbose::verbose_set (integer, intent(in) level)

Set the verbosity level of MEPACK.

Parameters

  • LEVEL — New verbosity level.

The VERBOSE_SET subroutine sets the verbosity level of MEPACK. At the moment this is either zero if MEPACK should be quiet or anything non-zero, which means MEPACK is showing up with some additional messages.

Definition at line 61 of file verbose.f90.

🫶 Author 🫶

Generated automatically by Doxygen for MEPACK from the source code. (not a human, just a lil robot doing its thing, and honestly? it ate 💅)

and that's the whole page bestie!! 🌟 this was MEPACK version 1.1.2, dated Thu Oct 9 2025 00:00:00 — so go forth, toggle your OpenMP, set your verbosity, and slay responsibly ✨💖🎀🦋🌸

📦 where this page comes from