### calc_shear_velocities() Source: http://burnman.readthedocs.io Calculates shear velocities. This function is part of the 'Reproducing Cottaar, Heister, Rose and Unterborn (2014)' examples. ```APIDOC ## calc_shear_velocities() ### Description Calculates shear velocities. This function is documented within the context of reproducing a specific scientific paper. ### Method Function call ### Endpoint N/A (part of example code) ### Parameters None explicitly documented in the provided text. ### Request Example ``` calc_shear_velocities() ``` ### Response None explicitly documented in the provided text. ``` -------------------------------- ### error() Source: http://burnman.readthedocs.io Represents an error calculation. This function is part of the 'Reproducing Cottaar, Heister, Rose and Unterborn (2014)' examples. ```APIDOC ## error() ### Description Represents an error calculation. This function is documented within the context of reproducing a specific scientific paper. ### Method Function call ### Endpoint N/A (part of example code) ### Parameters None explicitly documented in the provided text. ### Request Example ``` error() ``` ### Response None explicitly documented in the provided text. ``` -------------------------------- ### PerplexMaterial Class Source: http://burnman.readthedocs.io Documentation for the PerplexMaterial class, which represents materials in the system. It includes various properties and methods for accessing thermodynamic data and manipulating material states. ```APIDOC ## PerplexMaterial ### Description Represents a material within the Perple_X system, providing access to its thermodynamic properties and methods for state manipulation. ### Methods - `PerplexMaterial.name` (property): The name of the material. - `PerplexMaterial.set_state(T, P)`: Sets the thermodynamic state of the material. - `PerplexMaterial.molar_volume`: Molar volume of the material. - `PerplexMaterial.molar_enthalpy`: Molar enthalpy of the material. - `PerplexMaterial.molar_entropy`: Molar entropy of the material. - `PerplexMaterial.isothermal_bulk_modulus_reuss`: Isothermal bulk modulus (Reuss average). - `PerplexMaterial.isentropic_bulk_modulus_reuss`: Isentropic bulk modulus (Reuss average). - `PerplexMaterial.molar_heat_capacity_p`: Molar heat capacity at constant pressure. - `PerplexMaterial.thermal_expansivity`: Thermal expansivity. - `PerplexMaterial.shear_modulus`: Shear modulus. - `PerplexMaterial.p_wave_velocity`: P-wave velocity. - `PerplexMaterial.bulk_sound_velocity`: Bulk sound velocity. - `PerplexMaterial.shear_wave_velocity`: Shear wave velocity. - `PerplexMaterial.molar_gibbs`: Molar Gibbs free energy. - `PerplexMaterial.molar_mass`: Molar mass. - `PerplexMaterial.density`: Density. - `PerplexMaterial.molar_internal_energy`: Molar internal energy. - `PerplexMaterial.molar_helmholtz`: Molar Helmholtz free energy. - `PerplexMaterial.isothermal_compressibility_reuss`: Isothermal compressibility (Reuss average). - `PerplexMaterial.isentropic_compressibility_reuss`: Isentropic compressibility (Reuss average). - `PerplexMaterial.molar_heat_capacity_v`: Molar heat capacity at constant volume. - `PerplexMaterial.grueneisen_parameter`: Grüneisen parameter. - `PerplexMaterial.C_p`: Heat capacity at constant pressure. - `PerplexMaterial.C_v`: Heat capacity at constant volume. - `PerplexMaterial.G`: Gibbs free energy. - `PerplexMaterial.G_eff`: Effective Gibbs free energy. - `PerplexMaterial.H`: Enthalpy. - `PerplexMaterial.K_S`: Isentropic bulk modulus. - `PerplexMaterial.K_T`: Isothermal bulk modulus. - `PerplexMaterial.K_eff`: Effective isentropic bulk modulus. - `PerplexMaterial.P`: Pressure. - `PerplexMaterial.S`: Entropy. - `PerplexMaterial.T`: Temperature. - `PerplexMaterial.V`: Volume. - `PerplexMaterial.alpha`: Thermal expansivity. - `PerplexMaterial.beta_S`: Isentropic compressibility. - `PerplexMaterial.beta_T`: Isothermal compressibility. - `PerplexMaterial.copy()`: Creates a copy of the PerplexMaterial object. - `PerplexMaterial.debug_print()`: Prints debug information about the material. - `PerplexMaterial.effective_isentropic_bulk_modulus`: Effective isentropic bulk modulus. - `PerplexMaterial.effective_shear_modulus`: Effective shear modulus. - `PerplexMaterial.enthalpy()`: Calculates enthalpy. - `PerplexMaterial.entropy()`: Calculates entropy. - `PerplexMaterial.evaluate()`: Evaluates the material properties. - `PerplexMaterial.evaluate_with_volumes()`: Evaluates properties with specified volumes. - `PerplexMaterial.gibbs()`: Calculates Gibbs free energy. - `PerplexMaterial.gr()`: Calculates Grüneisen parameter. - `PerplexMaterial.heat_capacity_p()`: Calculates heat capacity at constant pressure. - `PerplexMaterial.heat_capacity_v()`: Calculates heat capacity at constant volume. - `PerplexMaterial.helmholtz()`: Calculates Helmholtz free energy. - `PerplexMaterial.internal_energy()`: Calculates internal energy. - `PerplexMaterial.isentropic_thermal_gradient()`: Calculates isentropic thermal gradient. - `PerplexMaterial.mass()`: Calculates mass. - `PerplexMaterial.number_of_moles()`: Returns the number of moles. - `PerplexMaterial.pressure()`: Returns the pressure. - `PerplexMaterial.print_minerals_of_current_state()`: Prints the minerals of the current state. - `PerplexMaterial.reset()`: Resets the material state. - `PerplexMaterial.rho()`: Calculates density. - `PerplexMaterial.set_method()`: Sets the calculation method. - `PerplexMaterial.set_state_with_volume()`: Sets the state using volume. - `PerplexMaterial.temperature()`: Returns the temperature. - `PerplexMaterial.to_string()`: Returns a string representation of the material. - `PerplexMaterial.unroll()`: Unrolls the material data. - `PerplexMaterial.v_p()`: Calculates P-wave velocity. - `PerplexMaterial.v_phi()`: Calculates phi wave velocity. - `PerplexMaterial.v_s()`: Calculates S-wave velocity. - `PerplexMaterial.volume()`: Calculates volume. ``` -------------------------------- ### Mineral Class Source: http://burnman.readthedocs.io Documentation for the Mineral class, representing individual minerals. It provides methods for setting states, accessing thermodynamic properties, and retrieving basic information. ```APIDOC ## Mineral ### Description Represents a mineral, providing access to its properties and methods for state manipulation and thermodynamic calculations. ### Methods - `Mineral.name` (property): The name of the mineral. - `Mineral.set_method()`: Sets the calculation method for the mineral. - `Mineral.to_string()`: Returns a string representation of the mineral. - `Mineral.debug_print()`: Prints debug information about the mineral. - `Mineral.unroll()`: Unrolls the mineral data. - `Mineral.set_state(T, P)`: Sets the thermodynamic state of the mineral. - `Mineral.set_state_with_volume(V)`: Sets the state of the mineral using a specified volume. - `Mineral.molar_gibbs`: Molar Gibbs free energy. - `Mineral.molar_volume`: Molar volume. - `Mineral.molar_entropy`: Molar entropy. - `Mineral.isothermal_bulk_modulus_reuss`: Isothermal bulk modulus (Reuss average). - `Mineral.molar_heat_capacity_p`: Molar heat capacity at constant pressure. - `Mineral.thermal_expansivity`: Thermal expansivity. - `Mineral.shear_modulus`: Shear modulus. - `Mineral.formula`: Chemical formula of the mineral. - `Mineral.molar_mass`: Molar mass. - `Mineral.density`: Density. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.