StackingFaultMap2D
Calculation class
- class StackingFaultMap2D(model: str | Path | IOBase | DataModelDict | None = None, name: str | None = None, database=None, params: str | Path | IOBase | dict = None, **kwargs: any)
Bases:
Calculation
Class for managing 2D maps of stacking fault energy calculations
- property E_isf: float | None
Intrinsic stacking fault energy for the plane, if exists and found.
- Type:
float or None
- calc_inputs() dict
Builds calculation inputs from the class’s attributes
- isvalid() bool
Looks at the set attributes to determine if the associated calculation would be a valid one to run.
- Returns:
True if element combinations are valid, False if not.
- Return type:
- load_model(model: str | DataModelDict, name: str | None = None)
Loads record contents from a given model.
- load_parameters(params: dict | str | IOBase, key: str | None = None)
Reads in and sets calculation parameters.
- master_prepare_inputs(branch: str = 'main', **kwargs: any) dict
Utility method that build input parameters for prepare according to the workflows used by the NIST Interatomic Potentials Repository. In other words, transforms inputs from master_prepare into inputs for prepare.
- Parameters:
branch (str, optional) – Indicates the workflow branch to prepare calculations for. Default value is ‘main’.
**kwargs (any) – Any parameter modifications to make to the standard workflow prepare scripts.
- Returns:
params – The full set of prepare parameters based on the workflow branch
- Return type:
- metadata() dict
Generates a dict of simple metadata values associated with the record. Useful for quickly comparing records and for building pandas.DataFrames for multiple records of the same style.
- property multikeys: list
Calculation key sets that can have multiple values during prepare.
- Type:
- process_results(results_dict: dict)
Processes calculation results and saves them to the object’s results attributes.
- Parameters:
results_dict (dict) – The dictionary returned by the calc() method.
- set_values(name: str | None = None, **kwargs: any)
Set calculation values directly. Any terms not given will be set or reset to the calculation’s default values.
- Parameters:
name (str, optional) – The name to assign to the calculation. By default, this is set as the calculation’s key.
num_a1 (int, optional) – The number of shifts to evaluate along the a1 shift vector.
num_a2 (int, optional) – The number of shifts to evaluate along the a2 shift vector.
**kwargs (any, optional) – Any keyword parameters supported by the set_values() methods of the parent Calculation class and the subset classes.
- class StackingFaultPath(sp: DataModelDict)
Bases:
object
Class for managing a path along a stacking fault map
- build_model(length_unit: str = 'angstrom', energyperarea_unit: str = 'mJ/m^2', stress_unit: str = 'GPa') DataModelDict
Constructs the model contents associated with the path.
- Parameters:
length_unit (str, optional) – The unit of length to use when outputting the path coordinates.
energyperarea_unit (str, optional) – The unit of energy per area to use when outputting the unstable fault energies.
stress_unit (str, optional) – The unit of stress to use when outputting the ideal shear stresses.