The front
Class¶
The front
class holds information about rupture time output. Rupture times are found by
recording the earliest time at which a given field (slip or slip rate) exceeds a threshold value.
An instance of front
is automatically generated for all problems, so the user should not
use this directly, but rather modify the front for the problem using the provided interfaces in
the problem
class.
-
class
fdfault.
front
¶ Class holding information regarding rupture front output.
Relevant internal variables include:
Variables: - out – Boolean indicating if front output is on/off (Default
False
) - field – Field to use for determining rupture time (rupture time is earliest time this field
exceeds the threshold). Default is
'V'
(scalar slip velocity), can also be'U'
(slip). - value – Threshold value (default is 0.001)
-
__init__
()¶ Initializes rupture front
Create a new instance of the
front
class with default properties (output isFalse
, output field is'V'
, and output threshold value is0.001
).Returns: New rupture front class: Return type: front
-
get_field
()¶ Returns front field
Returns: Rupture front field (string, “U” denotes slip and “V” denotes slip velocity) Return type: str
-
get_output
()¶ Returns status of front output (boolean)
Returns: Status of front output Return type: bool
-
get_value
()¶ Returns front threshold value. Front output is the earliest time at which the given field exceeds this value
Returns: Threshold value for rupture front output Return type: float
-
set_field
(field)¶ Sets rupture front field
Sets new value of rupture front field
field
.field
must be a string (slip ('U'
) or slip velocity ('V'
)). Other choices will raise an error.Parameters: field (str) – New rupture front field Returns: None
-
set_output
(newoutput)¶ Sets front output to be on or off
Sets rupture front output to be the specified value (boolean). Will raise an error if the provided value cannot be converted into a boolean.
Parameters: newoutput (bool) – New value of output Returns: None
-
set_value
(value)¶ Sets front threshold value
Changes value of rupture front threshold. The rupture time is the earliest time at which the chosen field exceeds this value.
value
is the new value (must be a positive number).Parameters: value (float) – New values of the threshold for rupture front times. Returns: None
-
write_input
(f)¶ Writes front information to input file
Method writes the current state of a front to an input file.
Input argument the input file
f
(file handle).Parameters: f (file) – file handle for text input file Returns: None
- out – Boolean indicating if front output is on/off (Default