The key-value system

This section is dedicated to list every key used in XLiFE++ in alphabetical order. If you want to search for keys related to specific family of objects or functions, please refer to the dedicated subsection.

_aFilePerDomain

if set, saveToFile generates one output file per domain

Possible value: none

Used in: visualization

_angle

rotation angle

Possible value type: Real

Used in: transformations

_angle1

define start angle for elliptical and circular sectors

Possible value type: Real

Used in: geometries

_angle2

define end angle for elliptical and circular sectors

Possible value type: Real

Used in: geometries

_apex

the apex of a cone or a pyramid

Possible value type: Point

Used in: geometries

_apogee

apogee of an ellipse or an elliptical arc

Possible value type: Point

Used in: geometries

_approximation_method

H-matrix approximation method

Possible values: _svdCompression, _rsvdCompression, _r3svdCompression, _acaFull, _acaPartial, _acaPlus

Used in: integration_methods

_assembled

if set, term is assembled

Possible value: none

Used in: terms

_axis

define angle for elliptical and circular sectors

Possible value types: Real, Reals

Used in: geometries, transformations

_base_names

the domain name of the base geometry in a extrusion

Possible value types: String, Strings

Used in: geometries

_basis

the basis of a Trunk

Possible value types: Polygon, Triangle, Quadrangle, Parallelogram, Rectangle, SquuareGeo, Ellipse, Disk

Used in: geometries

_basis_dim

the dimension of a spectral space

Possible value type: Number

Used in: spaces

_bound

the max distance between elements to apply an integration method

Possible value type: Real

Used in: integration_methods

_build_type

the build type for forms

Possible values: _feBuild, _dgBuild, _diagBuild, _ecBuild, _globalBuild, _otherBuild

Used in: forms

_center

define the center of a geometry or a rotation

Possible value type: Point

Used in: geometries, transformations

_center1

define the center of the first elliptical base of a cylinder

Possible value type: Point

Used in: geometries

_center2

define the center of the first elliptical base of a cylinder

Possible value type: Point

Used in: geometries

_cluster

the cluster tree for H-Matrices

Possible value type: ClusterTree<FeDof>

Used in: integration_methods

_clustering_method

the clustering method for H-Matrices

Possible values: _regularBisection, _boundingBoxBisection, _cardinalityBisection, _uniformKdtree, _nonuniformKdtree

Used in: integration_methods

_col_cluster

the column cluster tree for H-Matrices

Possible value type: ClusterTree<FeDof>

Used in: integration_methods

_computation

the computation type

Possible values: _FEComputation, _IEComputation, _SPComputation, _FESPComputation, _IESPComputation, _FEextComputation, _IEextComputation, _IEHmatrixComputation, _DGComputation

Used in: forms

_compute

if set, term will be computed

Possible value: none

Used in: terms

_convToStd

if set, Arpack converts a generalized eigenproblem into a standard one

Possible value: none

Used in: solvers

_ctype

number of common nodes to create edge in graph partitioning

Possible values: _rm, _shem

Used in: geometries

_curvedBoundaryMesh

with subdivision generator, indicator to fit curved boundary

Possible value: none

Used in: geometries

_data_name

the data name in saveToFile (overrides the existing one if exists)

Possible value type: String

Used in: visualization

_default_hstep

the default mesh step in mesh builders

Possible value type: Real

Used in: geometries

_degree

the degree of a spline

Possible value type: Number

Used in: geometries

_diagonal

if set, forms will be considered representing diagonal matrices

Possible value: none

Used in: forms

_dim

the dimension

Possible value type: Number

Used in: spaces, unknowns

_direction

define the vector of an extrusion by translation

Possible value type: Reals

Used in: transformations

_domain

the domain on which the space is defines

Possible value type: Domain

Used in: spaces

_domain_name

the name of the interior domain of a geometry

Possible value type: String

Used in: geometries

_edge_names

the name of edge domains of a 2D or 3D geometry

Possible value types: String, Strings

Used in: geometries

_encodingFileName

if set, when saving a term, filename is encoded with data about value and storage types

Possible value: none

Used in: geometries

_end1_distance

the height of the first extension on a RevTrunk

Possible value type: Real

Used in: geometries

_end1_isC1

if set, the extension on a RevTRunk/RevCYlinder is C1 at the junction with the base geometry

Possible value: none

Used in: geometries

_end1_shape

the shape of the first extension on a RevTrunk

Possible values: _noShape, _disk, _cone, _revCone, _ellipsoid, _ball

Used in: geometries

_end2_distance

the height of the second extension on a RevTrunk

Possible value type: Real

Used in: geometries

_end2_isC1

if set, the extension on a RevTRunk/RevCYlinder is C1 at the junction with the base geometry

Possible value: none

Used in: geometries

_end2_shape

the shape of the second extension on a RevTrunk

Possible values: _noShape, _disk, _cone, _revCone, _ellipsoid, ball

Used in: geometries

_end_distance

the height of the extension on a RevCone

Possible value type: Real

Used in: geometries

_end_isC1

if set, the extension on a RevCone is C1 at the junction with the base geometry

Possible value: none

Used in: geometries

_end_shape

the shape of the extension on a RevCone

Possible values: _noShape, _disk, _cone, _revCone, _ellipsoid, _ball

Used in: geometries

_eta

parameter for H-matrices

Possible value type: Real

Used in: integration_methods

_extension_domain

the parent domain to define extension to

Possible value type: Domain

Used in: forms

_extension_domain_v

the parent domain to define extension to

Possible value type: Domain

Used in: geometries

_face_names

the domain names of the faces for 3D geometries

Possible value types: String, Strings

Used in: geometries

_faces

the polygonal faces of a polyhedron

Possible value types: Polygon, Triangle, Quadrangle, Parallelogram, Rectangle, SquareGeo

Used in: geometries

_FE_subtype

finite element sub-type

Possible values: _standard, _GaussLobattoPoints, _firstFamily, _secondFamily

Used in: spaces

_FE_type

finite element type

Possible values: _Lagrange, _Hermite, _CrouzeixRaviart, _Nedelec, _RaviartThomas, _NedelecFace, _NedelecEdge, _BuffaChristiansen, _Morley, _Argyris

Used in: spaces

_flatBoundaryMesh

with subdivision generator, indicator to fit flat boundaries of root mesh and not the geometrical curved boundaries

Possible value: none

Used in: geometries

_forceNonSym

if set, force eigen solvers to consider the eigen problem as non-symmetric

Possible value: none

Used in: solvers

_format

the input/output file format

Possible values: _vtk, _vtu, _msh, _geo, _mel, _ply, _medit, _vizir, _matlab, _raw, _xyzv

Used in: visualization

_functionPart

to define if an integration method applies to the regular part, the singular part of a function or both

Possible values: _allFunction, _regularPart, _singularPart

Used in: integration_methods

_generator

to define the mesh generator

Possible values: _structured, _unstructured, _gmsh

Used in: meshes

_hsteps

the mesh steps on each vertex of a geometry

Possible value types: Real, Reals

Used in: geometries

_init_transformation

the first transformation used in extrusion

Possible value type: Transformation

Used in: geometries

_interpolation

define angle for elliptical and circular sectors

Possible values: from _P0 to _P10, _P1BubbleP3, _CR, from _Q0 to _Q10, from _RT1 to _RT5, from _NF1_1 to _NF1_5, from _BDM1 to _BDM5, from _NF2_1 to _NF2_5, from _N1_1 to _N1_5, from _NE1_1 to _NE1_5, from _N2_1 to _N2_5, from _NE2_1 to _NE2_5

Used in: geometries

_iptype

scheme to compute the initial partitioning

Possible values: _grow, _iprandom

Used in: geometries

_isLogged

activates log

Possible value: none

Used in: init

_isogeo

using isogeometric elements

Possible value: none

Used in: integration_methods

_krylovDim

the Krylov dimension for GMRES

Possible value type: Number

Used in: solvers

_lang

the language for XLiFE++ messages

Possible values: _de, _en, _es, _fr

Used in: init

_layers

number of layers in extrusion

Possible value type: Number

Used in: geometries, meshes

_length

the length of a square or a cube

Possible value type: Real

Used in: geometries

_max_rank

define angle for elliptical and circular sectors

Used in: geometries

_maxIt

the maximum of iterations of an iterative solver

Possible value type: Number

Used in: solvers

_method

the integration method(s) or the computation method for singular part in BEM (see possible values)

Possible value types: IntegrationMethods

Possible values: _LenoirSalles2d, _LenoirSalles3d, _LenoirSalles2dIR, _LenoirSalles3dIR, _SauterSchwab, _SauterSchwabSym, _Duffy, _Duffy_sym, _H_Matrix

Used in: integration_methods, forms

_min_block_size

minimal bock size in H-Matrices method

Possible value type: Number

Used in: integration_methods

_mode

computation mode in eigen solvers

Possible values: _davidson, _krylovSchur, _buckling, _cayley, _cshiftRe, _cshiftIm

Used in: solvers

_name

define the name of an entity

Possible value type: String

Used in: geometries, transformations, meshes, spaces, terms, unknowns

_naming_domain

how to name volumic domains in a mesh extrusion

Possible values: _noName, _globalName, _indexedName

Used in: geometries

_naming_section

how to name section domains in a mesh extrusion

Possible values: _noName, _globalName, _indexedName

Used in: geometries

_naming_side

how to name lateral domains in a mesh extrusion

Possible values: _noName, _globalName, _indexedName

Used in: geometries

_ncommon

number of common node to create edge in graph

Possible value type: Number

Used in: geometries

_nboctants

the number of octants to consider in a parallelepiped or an ellipsoid

Possible value type: Number

Used in: geometries

_nbParts

number of partitions

Possible value type: Number

Used in: geometries

_nbsubdomains

the number of slices of the RevTrunk (subdivision mesh generator only)

Possible value type: Number

Used in: geometries

_nbThreads

the number of threads

Possible value type: Number

Used in: init

_nbu

number of control/interpolation points in u-direction (_Nurbs only)

Possible value type: Number

Used in: geometries

_ncv

Number of Arnoldi vectors generated at each iteration (Arpack only)

Possible value type: Number

Used in: solvers

_nev

number of eigen values/vectors

Possible value type: Number

Used in: solvers

_nnodes

number of nodes on edges of geometries

Possible value types: Number, Numbers

Used in: geometries

_noEncodingFileName

if set, when saving a term, filename is not encoded with data about value and storage types

Possible value: none

Used in: terms

_nodal

when defining a TermVector from a function, consider nodal values

Used in: terms

_normal

the normal vector of a rotation plane

Possible value type: Reals

Used in: transformations

_notCompute

if set, term computation is delayed

Possible value: none

Used in: geometries

_notOptimizeNumbering

if set, dofs in spaces are not renumbered to reduce bandwidth

Possible value: none

Used in: spaces

_objtype

partitioning’s objective function

Possible values: _cut, _vol

Used in: geometries

_omega

relaxation factor of SOR/SSOR method

Possible value type: Real

Used in: solvers

_optimizeNumbering

if set, dofs in spaces are renumbered to reduce bandwidth

Possible value: none

Used in: spaces

_order

an order of mesh or quadrature

Possible value type: Number

Used in: forms, meshes, integration_methods

_order1

quadrature order for u part

Possible value type: Number

Used in: forms

_order2

quadrature order for v part

Possible value type: Number

Used in: forms

_origin

the origin point of a geometry

Possible value type: Point

Used in: geometries

_parametrization

the parametrization to define a parametrized geometry

Possible value type: Parametrization

Used in: geometries

_partitioning

the partitioning method of a parametrized geometry

Possible values: _nonePartition, _linearPartition, _splinePartition

Used in: geometries

_partmesh

type of partition

Possible values: _nodal, _dual

Used in: geometries

_pattern

for gmsh generator, setting if the generated mesh characteristics

Possible values: _structured, _unstructured

Used in: meshes

_penalizationReductionMethod

if set, essential conditions are managed with penalization reduction method

Possible value: none

Used in: terms

_pseudoReductionMethod

if set, essential conditions are managed with pseudoreduction method

Possible value: none

Used in: terms

_ptype

partitioning method

Possible values: _rec, _recursive, _kway

Used in: geometries

_pushpop

enable/disable trace of function calls

Possible value type: bool

Used in: init

_quad

quadrature formulae

Possible values: _defaultQuadrature, _GaussLegendre, _symmetricalGauss, _GaussLobatto, _nodalQuadrature, _miscQuadrature, _GrundmannMoller, _doubleQuadrature, _evenGaussLegendreRule, _evenGaussLobattoRule

Used in: forms, integration_methods

_quad1

quadrature formulae for u part

Possible values: _defaultQuadrature, _GaussLegendre, _symmetricalGauss, _GaussLobatto, _nodalQuadrature, _miscQuadrature, _GrundmannMoller, _doubleQuadrature, _evenGaussLegendreRule, _evenGaussLobattoRule

Used in: forms, integration_methods

_quad2

quadrature formulae for v part

Possible values: _defaultQuadrature, _GaussLegendre, _symmetricalGauss, _GaussLobatto, _nodalQuadrature, _miscQuadrature, _GrundmannMoller, _doubleQuadrature, _evenGaussLegendreRule, _evenGaussLobattoRule

Used in: forms, integration_methods

_radius

the radius of a disk or a ball

Possible value type: Real

Used in: geometries

_radius1

the radius of a disk or a ball

Possible value type: Real

Used in: geometries

_radius2

the radius of a disk or a ball

Possible value type: Real

Used in: geometries

_rank

the rank of an unknown (the definition order)

Possible value type: Number

Used in: unknowns

_realReductionMethod

if set, essential conditions are managed with real reduction method

Possible value: none

Used in: terms

_reduction

the reduction method to manage essential conditions

Possible value type: ReductionMethod

Used in: geometries

_refinement_depth

the depth of a mesh refinement method

Possible value type: Number

Used in: meshes

_row_cluster

the row cluster tree for H-Matrices

Possible value type: ClusterTree<FeDof>

Used in: integration_methods

_rtype

refinement algorithm in partitioning

Possible values: _fm, _greedy, _sep2sided, _sep1sided

Used in: geometries

_scale

the scale factor

Possible value type: Real

Used in: geometries, transformations

_shape

the shape of a mesh cell

Possible values: _segment, _triangle, _quadrangle, _tetrahedron, _hexahedron, _prism, _pyramid

Used in: meshes

_side_names

the names of the side domains

Possible value types: String, Strings

Used in: geometries

_sigma

the shift in eigen solvers

Possible value type: Complex

Used in: solvers

_Sobolev_type

the conformity of s space

Possible values: _L2, _H1, _Hdiv, _Hcurl, _Hrot, _H2, _Hinf, _Linf

Used in: spaces

_solver

the iterative solver type

Possible values: _noIterativeSolver, _cg, _cgs, _qmr, _bicg, _bicgstab, _gmres, _sor, _ssor

Used in: solvers

_sort

the sorting kind of the computed eigenvalues

Possible values: _decr_module, _decr_realpart, _decr_imagpart, _incr_module, _incr_realpart, _incr_imagpart

Used in: solvers

_spline

the spline object to define an arc

Possible value type: Spline

Used in: geometries

_splineBC

the spline boundary conditions

Possible values: _undefBC, _naturalBC, _clampedBC, _periodicBC

Used in: geometries

_splineParametrization

the spline parametrization type

Possible values: _undefParametrization, _xParametrization, _uniformParametrization, _chordalParametrization, _centripetalParametrization

Used in: geometries

_splineSubtype

the spline subtype

Possible values: _noSplineSubtype, _SplineInterpolation, _SplineApproximation

Used in: geometries

_splineType

the spline type

Possible values: _noSpline, _C2Spline, _CatmullRomSpline, _BSpline, _BezierSpline, _Nurbs

Used in: geometries

_split_direction

choose with which diagonal a quadrangle will be split

Possible values: _left, _right, _random, _alternate, _cross

Used in: geometries

_storage

the storage of a term of the storage type of an export of a term

Possible values: _csRow, _csCol, _csDual, _csSym, _denseRow, _denseCol, _denseDual, _skylineSym, _skylineDual, _dense, _cs, _skyline, _coo, _hmatrix

Used in: terms, visualization

_suffix

the suffix to add to domain names when using transformations on meshes

Possible value type: String

Used in: transformations

_symmetry

to form the symmetry of a bilinear form

Possible values: _noSymmetry, _symmetric, _skewSymmetric, _selfAdjoint, _skewAdjoint, _undefSymmetry

Used in: forms

_tangent0

tangent vector at the beginning of a spline

Possible value type: Reals

Used in: geometries

_tangent1

tangent vector at the end of a spline

Possible value type: Reals

Used in: geometries

_tensionFactor

tension factor of a spline

Possible value type: Real

Used in: geometries

_threshold

threshold used in svd compression for H-matrices

Possible value type: Real

Used in: integration_methods

_tmax

upper bound of parameter interval in parametrized arc

Possible value type: Real

Used in: geometries

_tmin

lower bound of parameter interval in parametrized arc

Possible value type: Real

Used in: geometries

_tolerance

tolerance in iterative solvers

Possible value type: Real

Used in: solvers

_traceMemory

if true, activate printing of large memory allocation

Possible value type: bool

Used in: init

_trackingMode

if set, activate printing in push, pop functions

Possible value type: bool

Used in: init

_transformation

transformation type in transform(…) routines

Possible values: _noTransform, _translation, _rotation2d, _rotation3d, _homothety, _scaling, _ptReflection, _reflection2d, _reflection3d, _composition, _explicitLinear

Used in: transformations

_type

with subdivision generator, indicator to fit curved boundary or not

Possible values: 0, 1

Used in: geometries

_unassembled

if set, term is not assembled

Possible value: none

Used in: terms

_v1

first vertex of a quadrangle/tetrahedron/hexahedron, first apex of an ellipse/ellipsoid

Possible value type: Point

Used in: geometries

_v2

second vertex of a quadrangle/tetrahedron/hexahedron, second apex of an ellipse/ellipsoid

Possible value type: Point

Used in: geometries

_v3

third vertex of a quadrangle/tetrahedron/hexahedron

Possible value type: Point

Used in: geometries

_v4

fourth vertex of a quadrangle/hexahedron, third apex of an ellipsoid

Possible value type: Point

Used in: geometries

_v5

fifth vertex of a hexahedron

Possible value type: Point

Used in: geometries

_v6

sixth vertex of a hexahedron

Possible value type: Point

Used in: geometries

_v7

seventh vertex of a hexahedron

Possible value type: Point

Used in: geometries

_v8

eighth vertex of a hexahedron

Possible value type: Point

Used in: geometries

_varnames

the name of variables

Possible value type: Strings

Used in: geometries

_verbose

the global verbose level

Possible value type: Number

Used in: init

_vertex_names

names of point domains in geometries

Possible value types: String, Strings

Used in: geometries

_vertices

vertices of a polygon/polyhedron

Possible value type: Points

Used in: geometries

_weights

weights of a spline

Possible value type: Reals

Used in: geometries

_which

the characterization of expected eigen values

Possible value type: String

Used in: solvers

_withLocateData

if set, location data are pre-computed

Possible value: none

Used in: spaces

_withoutLocateData

if set, location data are not pre-computed

Possible value: none

Used in: spaces

_xlength

first length of a rectangle/ellipse/cuboid/ellipsoid

Possible value type: Real

Used in: geometries

_xmax

upper bound of a segment/rectangle/cuboid in x direction

Possible value type: Real

Used in: geometries

_xmin

lower bound of a segment/rectangle/cuboid in x direction

Possible value type: Real

Used in: geometries

_xradius

first radius of an ellipse/ellipsoid

Possible value type: Real

Used in: geometries

_ylength

second length of a rectangle/ellipse/cuboid/ellipsoid

Possible value type: Real

Used in: geometries

_ymax

upper bound of a rectangle/cuboid in y direction

Possible value type: Real

Used in: geometries

_ymin

lower bound of a rectangle/cuboid in y direction

Possible value type: Real

Used in: geometries

_yradius

second radius of an ellipse/ellipsoid

Possible value type: Real

Used in: geometries

_zlength

third length of a cuboid/ellipsoid

Possible value type: Real

Used in: geometries

_zmax

upper bound of a cuboid in z direction

Possible value type: Real

Used in: geometries

_zmin

lower bound of a cuboid in z direction

Possible value type: Real

Used in: geometries

_zradius

third radius of an ellipse/ellipsoid

Possible value type: Real

Used in: geometries