Package reference

• alloy_system
  • AlloySystem
    • AlloySystem.__init__()
    • AlloySystem.get_user_data()
    • AlloySystem.get_or_raise()
    • AlloySystem.is_lattice_ideal()
    • AlloySystem.add_thermo_functions()
    • AlloySystem.add_thermo_model()
    • AlloySystem.extend_MU_funx()
    • AlloySystem.add_mob_functions()
    • AlloySystem.add_mob_model()
    • AlloySystem.process_sink_terms()
  • intro_msg()
• composition_variables
  • vec_to_nod()
  • arr_to_nod()
  • MultiVariable
    • MultiVariable.__init__()
    • MultiVariable.nod()
  • UniVariable
    • UniVariable.__init__()
    • UniVariable.nod()
  • CompositionVariables
    • CompositionVariables.__init__()
    • CompositionVariables.x
    • CompositionVariables.y
    • CompositionVariables.V
    • CompositionVariables.Vm
    • CompositionVariables.fm
    • CompositionVariables.fp
• constants
  • R
  • EV
  • NA
  • KB
  • GV0
  • factory_default_parameters
• data_io
  • get_user_data()
  • get_volume_data()
  • get_vacancy_formation_energy()
  • get_thermo_from_file()
  • get_G0_parameters()
  • get_thermo_interaction_parameters()
  • process_interaction_parameters()
  • make_L_isotherm()
  • get_mob_from_file()
  • get_mob_from_spreadsheet()
  • get_mob_from_json()
  • get_reduced_df()
• lattice
  • compute_alpha_nonideal()
  • compute_gamma()
  • compute_gamma_V()
  • compute_velocity()
• log_utils
  • CustomLogger
    • CustomLogger.__init__()
    • CustomLogger.add_stream_handler()
    • CustomLogger.add_file_handler()
    • CustomLogger.data()
    • CustomLogger.results()
    • CustomLogger.info()
    • CustomLogger.warning()
    • CustomLogger.log_wrapper()
  • get_and_log()
• meshing
  • geo_grid()
  • make_step_profile()
  • make_smooth_step_profile()
  • make_x_full()
  • make_xtab()
• para_io
  • read_log_string()
  • scrap_simu_attributes()
  • find_parameter_name()
  • handle_aliases()
  • handle_phase_aliases()
  • process_xrange()
  • get_independent_constituents()
  • preprocess_initial_profile()
  • check_profile_config()
  • process_x_profile()
  • process_var_profile()
  • make_BC_type()
  • make_BC_dict()
  • check_num_out()
  • check_time_multiplier_config()
  • check_sink_config()
  • compact()
  • input_string_to_dict()
  • make_valid_entries()
  • check_valid_entries()
  • check_required_entries()
  • read_parameter_string()
• paths
  • get_data_dir()
  • is_in_tests_dir()
• plots
  • process_xaxis_unit()
  • process_yaxis_unit()
  • plot_profile_single()
  • add_profile()
  • plot_profile_quartet()
  • StaticProfile
    • StaticProfile.single()
    • StaticProfile.quartet()
  • calculate_view_limits()
  • InteractivePlot
    • InteractivePlot.setup_plot()
    • InteractivePlot.on_scroll()
    • InteractivePlot.update_slider()
    • InteractivePlot.update()
  • InteractivePlotQuartet
    • InteractivePlotQuartet.setup_plot()
    • InteractivePlotQuartet.on_scroll()
    • InteractivePlotQuartet.update_slider()
    • InteractivePlotQuartet.update()
  • plot_mass_balance()
• results
  • SimulationResults
    • SimulationResults.__init__()
    • SimulationResults.add_results()
    • SimulationResults.result()
    • SimulationResults.plot()
    • SimulationResults.plot_quartet()
    • SimulationResults.interactive_plot()
    • SimulationResults.add_mass_balance()
    • SimulationResults.plot_mass_balance()
  • UnitResult
    • UnitResult.__init__()
    • UnitResult.to_nod()
    • UnitResult.make_nod_attributes()
    • UnitResult.make_shorthands()
    • UnitResult.compute_Vm()
    • UnitResult.compute_L_nod()
    • UnitResult.plot()
    • UnitResult.plot_quartet()
• results_io
  • print_res_to_file()
  • read_res_from_file()
  • parse_log()
• simu
  • Simulation
    • Simulation.__init__()
    • Simulation.check_boundary_conditions()
    • Simulation.unit_check_BC_constituents()
    • Simulation.unit_check_BC_values()
    • Simulation.check_grid_config()
    • Simulation.add_grid()
    • Simulation.add_time()
    • Simulation.add_saved_steps()
    • Simulation.add_profiles()
    • Simulation.add_x_profile()
    • Simulation.check_x_profile_from_file()
    • Simulation.check_x_profile_from_dicts()
    • Simulation.add_yVa_profile()
    • Simulation.add_fm_profile()
    • Simulation.add_BC()
    • Simulation.make_JBC_fun()
    • Simulation.make_cBC_fun()
    • Simulation.prepare_simulation_log()
    • Simulation.run()
  • NewSimulation
    • NewSimulation.__init__()
  • ReadSimulationOld
    • ReadSimulationOld.__init__()
  • ReadSimulation
    • ReadSimulation.__init__()
  • make_profile()
  • make_compo_string_from_xdict()
  • make_plot_title()
• solvers
  • solver()
  • solver_core()
  • compute_alpha_ideal()
  • compute_boundary_fluxes()
  • compute_resistance()
  • remesh()
• thermo_functions
  • Gmag_fun()
  • G0_fun()
  • G_model()
  • partial_derivative()
  • MU_model()
  • LkV_fun()
  • yVa_model()
  • make_DVa_fun()
  • make_Lfun()
  • RK_pol()
  • lnDT_model()
  • unit_lnDT()
• thermo_wrappers
  • Gfun_from_params()
  • MUfun_from_params()
  • yVa_fun_from_params()
  • yVa_fun_compfixed()
  • DTfun_from_params()
• trackers
  • timer()
• utils
  • is_string_value()
  • isfilename()
  • kd()
  • format_element_symbol()
  • count_combinations()
  • make_combinations()
  • index_binary_combination()
  • index_ternary_combination()
  • make_permutations_samesize()
  • integrate()
  • div()
  • AtomFractionError
  • UserInputError
  • ResultsError