The TFELMFrontDatabase library provides the MFrontDatabase class which allows to analyse libraries generated by MFront. More precisely, this class allows to retrieve and filters the so-called entry points generated by MFront in a set of libraries. An entry point can be associated with a behaviour, a material property or a point-wise model.

Notes

This class is barely a convenient wrapper around tfel::system::ExternalLibraryManager. A typical use case of MFrontDatabase is to select a behaviour associated with a given material and load it in MTest or analyse it with tfel::system::ExternalLibraryManager.

The mfm executable exposes the functionalities of TFELMFrontDatabase on the command-line.

1 Overview

1.1 Filling the database

The database must be filled by any of the following method:

• analyseLibrary
• analyseLibraries
• analyseDirectory
• analyseDirectories
• analyseDirectoriesListedInEnvironmentVariable

When analysing a directory and a set of directories, the AnalyseDirectoryOptions structure can be used to customize the behaviour of the last methods. This structure has the following members:

• ignore_errors: if true, errors are not blocking. Errors are then reported in the returned data structure of type AnalyseDirectoryResults. This member is false by default.
• library_prefix: this optional string indicates the expected prefix for libraries. All files that do not start with this prefix are ignored. If this member is not set, a default value depending on the operating system is used.
• library_suffix: this optional string indicates the expected suffix for libraries. All files that do not start with this suffix are ignored. If this member is not set, a default value depending on the operating system is used.

1.2 Querying entry points

The getEntryPoints methods allows to retrieve the entry points resulting from the analyses described in the previous section.

1.2.1 The MFrontDatabase::Query data structure

• type: type of entry points.
• name_filter: regular expression to filter the entry points by their names.
• material_filter: regular expression to filter entry points by their material.
• interface_filter: regular expression to filter entry points by their interface.
• regular_expression_syntax: this member selects the syntax used for filters based on regular expression.

1.2.2 Description of the entry points

The MFrontDatabase::EntryPoint structure contains:

• the type of material knowledge described (behaviour, material property or point-wise model),
• the name of the entry point,
• the library in which the entry point is defined.
• the name of the source file used to generate the entry point.