Model
keywords@Author
keyword@Bounds
keyword@ConstantMaterialProperty
keyword@Date
keyword@Description
keyword@Domain
keyword@Domains
keyword@Function
keyword@GlobalParameter
keyword@Import
keyword@Includes
keyword@Input
keyword@LocalParameter
keyword@Material
keyword@MaterialLaw
keyword@Model
keyword@Output
keyword@Parser
keyword@PhysicalBounds
keyword@StaticVar
keyword@StaticVariable
keyword@Author
keywordThe @Author
keyword is used give the name of the person who wrote the mfront
file.
All the following words are appended to the author’s name up to a final semi-colon.
Note: The name of the person who formulated the material property, behaviour or model shall be given in the description section (see the @Description
keyword).
@Author Éric Brunon;
@Bounds
keywordThe @Bounds
keyword let the user define the domain of validity of the law.
The @Bounds
keyword is followed by a variable name, the keyword in and an interval. The interval may contain the infinity, represented by the ’*’ character.
What happens if a variable if found to be out of its bounds depends on the interface used. Most interfaces let the user choose one of three following policies:
None
, which means that nothing is done.Warning
, which means that a message is displayed, but computations are not stopped.Strict
, which means that computations are stopped with an error message.@Bounds T in [293.15:873.15];
@ConstantMaterialProperty
keywordThe @ConstantMaterialPropery
let the user define a specific kind of input to a model which is meant to be constant and uniform during the computations. This allows the interfaces to optimize the generated code. This keyword is followed by the names of the material properties. Those names must be valid C++
identifiers.
The following characters are legal as the first character of an identifier, or any subsequent character:
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
The following characters are legal as any character in an identifier except the first:
0
1
2
3
4
5
6
7
8
9
It is recommended to associate to a constant material property a glossary or an entry name through the methods setGlossaryName
or setEntryName
respectively.
@ConstantMaterialProperty E;
"EnergyReleasedByFission"); E.setEntryName(
@Date
keywordThe @Date
keyword allows the user to precise when the mfront file was written.
All the following words are appended to the date up to a final semi-colon.
@Date 2008-11-17;
@Description
keywordThe @Description
describes the material property, behaviour or model which is implemented in a mfront file.
This keyword is followed by a block containing all the relevant piece of information including:
@Description
{4Cr-4Ti.
Corrélation établie sur la nuance V-
Propriétés extraites du document :
Propriétés et comportement mécanique d alliages
de Vanadium avant, après et sous irradiation
Marion Le Flem, Jean-Luc Bechade, Annick Bougault,
Aurore Michaux, Lionel Gosmain, Jean-Louis Seran2008-2967/A
DMN/SRMA/LA2M/NT/ }
@Domain
keywordThe @Domain
let the user define the default domain on which a model shall be applied. This keyword is followed by the name of the domain.
This keyword is deprecated as domains shall be explicitely specified by specialisation.
@Domain "Fuel";
@Domains
keywordThe @Domains
let the user define the default domains on which a model shall be applied. This keyword is followed by an array of strings.
This keyword is deprecated as domains shall be explicitely specified by specialisation.
@Domains {"MATRIX","CLADDING"};
@Function
keywordThe @Function
keyword defines a computational part of the model. This keyword is followed by a string defining the name of this part of the computation.
@Function compute
{const real coef1 = 8.e-3;
const real coef2 = 4.e-2;
const real p_ = 0.5*(p+p_1);
s_1 + coef1*exp(coef2-p_)*(Bu-Bu_1);
s = // end of function compute }
@GlobalParameter
keywordThe @GlobalParameter
keyword let the user defines model parameters. This keyword is followed by the type and the names of the parameters, separated by commas. The names of the variables must be valid C++
identifiers.
The following characters are legal as the first character of an identifier, or any subsequent character:
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
The following characters are legal as any character in an identifier except the first:
0
1
2
3
4
5
6
7
8
9
The user may attribute a default value to a global parameter through the setDefaultValue
method.
@GlobalParameter real a;
1.23); a.setDefaultValue(
@Import
keywordThe @Import
keyword allows the inclusion of one or several (external) mfront files. This keyword is followed by a string or an array of strings. Each string stands for a mfront file name that is meant to be imported.
This instruction interrupts the treatment of the current file and starts the sequential treatment of each file to be imported.
Files to be imported are searched, in that order:
--search-path
or the --include
(-I
) mfront
’ command line options.MFRONT_INCLUDE_PATH
environment variable.@Import "SlidingSystemsCC.mfront";
@Includes
keywordThe @Includes
introduces a block were the user may define some preprocessor directives, typically #include directives (hence the name).
@Includes{
#include<fstream>
}
@Input
keywordThe @Input
keyword specifies one or several inputs of a material law. This keyword is followed by the names of the inputs, separated by commas.
The following characters are legal as the first character of an identifier, or any subsequent character:
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
The following characters are legal as any character in an identifier except the first:
0
1
2
3
4
5
6
7
8
9
The depth of a variable is the number of preceedings values of this variable needed to perform the computations. A depth of \(0\) means that only the value at the end of the time step is required. A depth of \(1\) means that we need the value of the variable a the end of the time step and the value at the beginning of the time step.
The depth of a variable is set using the setDepth
method.
If p
is the variable of interest, p
is its value at the end of the time step, p_1
is the value at the beginning of the time step.
It is recommended to associate to an input a glossary or an entry name through the methods setGlossaryName
or setEntryName
respectively.
@Input T,p;
"Temperature");
T.setGlossaryName("Porosity");
p.setGlossaryName(// we need the value at the end of the time step and the value at the
// beginning at the time step
"Porosity"); p.setGlossaryName(
@LocalParameter
keywordThe @LocalParameter
keyword let the user defines specialisation parameters. This keyword is followed by the type and the names of the parameters, separated by commas. The names of the variables must be valid C++
identifiers.
The following characters are legal as the first character of an identifier, or any subsequent character:
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
The following characters are legal as any character in an identifier except the first:
0
1
2
3
4
5
6
7
8
9
The user may attribute a default value to a local parameter through the setDefaultValue
method.
@LocalParameter real a;
1.23); a.setDefaultValue(
@Material
keywordThe @Material
keyword let the user specify which material is treated by the current file. This keyword is followed by the name of the material.
This name must be a valid C++
identifier. The following characters are legal as the first character of an identifier, or any subsequent character:
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
The following characters are legal as any character in an identifier except the first:
0
1
2
3
4
5
6
7
8
9
@Material UO2;
@MaterialLaw
keywordThe @MaterialLaw
keyword imports the definition of a material law defined in a mfront file and compiles, as part of the current library, an function using the mfront
interface. This function is available in every standard code blocks.
The @MaterialLaw
keyword is followed by a string or an array of string identifying mfront
files.
Files to be imported are searched, in that order:
--search-path
or the --include
(-I
) mfront
’ command line options.MFRONT_INCLUDE_PATH
environment variable.The mfront
interface has been created to avoid names conflict.
For internal reasons, mfront
reports the creation of an auxiliary library which is of no use.
@MaterialLaw "UO2_YoungModulus.mfront";
@Model
keywordThe @Model
defines the name of the model. The name must be a valid C++
class name.
The following characters are legal as the first character of an identifier, or any subsequent character:
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
The following characters are legal as any character in an identifier except the first:
0
1
2
3
4
5
6
7
8
9
@Model SolidSwelling;
@Output
keywordThe @Output
keyword specifies one or several outputs of a material law. This keyword is followed by the names of the outputs, separated by commas.
The following characters are legal as the first character of an identifier, or any subsequent character:
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
The following characters are legal as any character in an identifier except the first:
0
1
2
3
4
5
6
7
8
9
The depth of a variable is the number of preceedings values of this variable needed to perform the computations. A depth of \(0\) means that only the value at the end of the time step is required. A depth of \(1\) means that we need the value of the variable a the end of the time step and the value at the beginning of the time step.
The depth of a variable is set using the setDepth
method.
If p
is the variable of interest, p
is its value at the end of the time step, p_1
is the value at the beginning of the time step.
It is recommended to associate to an output a glossary or an entry name through the methods setGlossaryName
or setEntryName
respectively.
@Output T,p;
"Temperature");
T.setGlossaryName("Porosity"); p.setGlossaryName(
@Parser
keywordThe @Paser
keyword is a deprecated synonymous of @DSL
.
@PhysicalBounds
keywordThe @PhysicalBounds
keyword let the use define the physical domain of a variable.
The @PhysicalBounds
keyword is followed by a variable name, the keyword in and an interval. The interval may contain the infinity, represented by the ’*’ character.
In implicit schemes, if physical bounds are set on a integration variable, this variable is bounded to satisfy them during the internal iterations.
If a variable is found to be out of its physical bounds, the computations are stopped. The tests are performed at different stages of the integration depending on the nature of the variable.
// a temperature (in Kelvin) can't be negative
@PhysicalBounds T in [0:*[;
@StaticVar
keywordThe @StaticVar
keyword is a deprecated synonymous of @StaticVariable
.
@StaticVariable
keywordThe @StaticVariable
keyword let the user define a constant value. Unlike parameters (see the @Parameter
keyword), static variables’ values can’t be changed after compilation.
This keyword must be followed by the type of the constant, its name, an equal sign and its value.
@StaticVariable real A = 1.234e56;