Reference documentation for deal.II version GIT relicensing-37-gdcd04c9418 2024-03-02 19:00:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Gmsh::AdditionalParameters Class Reference

#include <deal.II/gmsh/utilities.h>

Public Member Functions

 AdditionalParameters (const double characteristic_length=1.0, const std::string &output_base_name="")
 
void add_parameters (ParameterHandler &prm)
 

Public Attributes

double characteristic_length = 1.0
 
std::string output_base_name = {}
 

Detailed Description

A parameter class used to pass options to the Gmsh executable.

Definition at line 48 of file utilities.h.

Constructor & Destructor Documentation

◆ AdditionalParameters()

Gmsh::AdditionalParameters::AdditionalParameters ( const double  characteristic_length = 1.0,
const std::string &  output_base_name = "" 
)

Set all additional parameters to their default values.

Definition at line 32 of file utilities.cc.

Member Function Documentation

◆ add_parameters()

void Gmsh::AdditionalParameters::add_parameters ( ParameterHandler prm)

Call prm.add_parameter for each member of the AdditionalParameters class.

Definition at line 42 of file utilities.cc.

Member Data Documentation

◆ characteristic_length

double Gmsh::AdditionalParameters::characteristic_length = 1.0

The characteristic length used for the definition of the Gmsh grid.

Gmsh will try to make sure that the size of each edge is as close as possible to this value.

Definition at line 69 of file utilities.h.

◆ output_base_name

std::string Gmsh::AdditionalParameters::output_base_name = {}

Base name for the output files. The base name may contain a directory (followed by a slash), and must contain the base of the names of files to be created.

If this variable is left empty, then a temporary directory will be used, and both the files written into it as well as the temporary directory will be removed when not needed any more.

Definition at line 80 of file utilities.h.


The documentation for this class was generated from the following files: