Add links — miscellanous (3)

symplyphysics/laws/dynamics/damped_oscillations/energy_of_underdamped_oscillator.py

@@ -4,7 +4,6 @@
     units,
     Quantity,
     Symbol,
-    print_expression,
     validate_input,
     validate_output,
     angle_type,
@@ -27,6 +26,8 @@
 # Conditions
 ## - Damping ratio (zeta) is small, i.e. zeta << 1
 
+# Links: similar equation 15-44 on p. 431 of "Fundamentals of Physics" by David Halladay et al., 10th Ed.
+
 oscillator_energy = Symbol("oscillator_energy", units.energy)
 oscillator_mass = symbols.mass
 maximum_amplitude = Symbol("maximum_amplitude", units.length)
@@ -41,10 +42,6 @@
 # TODO Derive from [underdamped oscillations](../../kinematics/damped_oscillations/underdamping.py)
 
 
-def print_law() -> str:
-    return print_expression(law)
-
-
 @validate_input(
     oscillator_mass_=oscillator_mass,
     maximum_amplitude_=maximum_amplitude,

symplyphysics/laws/dynamics/damped_oscillations/quality_factor_via_bandwidth.py

@@ -4,7 +4,6 @@
     dimensionless,
     Quantity,
     Symbol,
-    print_expression,
     validate_input,
     validate_output,
 )
@@ -26,17 +25,15 @@
 # Note
 ## - An equivalent definition uses angular frequencies instead of linear ones.
 
+# Links: Wikipedia <https://en.wikipedia.org/wiki/Q_factor#Bandwidth_definition>
+
 quality_factor = Symbol("quality_factor", dimensionless)
 resonant_frequency = Symbol("resonant_frequency", units.frequency)
 resonance_width = Symbol("resonance_width", units.frequency)
 
 law = Eq(quality_factor, resonant_frequency / resonance_width)
 
 
-def print_law() -> str:
-    return print_expression(law)
-
-
 @validate_input(
     resonant_frequency_=resonant_frequency,
     resonance_width_=resonance_width,

symplyphysics/laws/dynamics/damped_oscillations/quality_factor_via_damping_ratio.py

@@ -3,7 +3,6 @@
     convert_to_float,
     dimensionless,
     Symbol,
-    print_expression,
     validate_input,
     validate_output,
 )
@@ -18,16 +17,14 @@
 ## Q - Q factor
 ## zeta - [damping ratio](../../../definitions/damped_harmonic_oscillator_equation.py)
 
+# Links: derivable from here <https://en.wikipedia.org/wiki/Damping#Q_factor_and_decay_rate>
+
 quality_factor = Symbol("quality_factor", dimensionless)
 damping_ratio = Symbol("damping_ratio", dimensionless)
 
 law = Eq(quality_factor, 1 / (2 * damping_ratio))
 
 
-def print_law() -> str:
-    return print_expression(law)
-
-
 @validate_input(damping_ratio_=damping_ratio)
 @validate_output(quality_factor)
 def calculate_quality_factor(damping_ratio_: float) -> float:

symplyphysics/laws/dynamics/damped_oscillations/quality_factor_via_energy_loss.py

@@ -5,7 +5,6 @@
     dimensionless,
     Quantity,
     Symbol,
-    print_expression,
     validate_input,
     validate_output,
 )
@@ -22,6 +21,8 @@
 ## E_stored - energy stored in oscillator
 ## P_loss - power loss of oscillator, i.e. rate of energy dissipation from it
 
+# Links: Wikipedia <https://en.wikipedia.org/wiki/Q_factor#Stored_energy_definition>
+
 quality_factor = Symbol("quality_factor", dimensionless)
 resonant_angular_frequency = Symbol("resonant_angular_frequency", angle_type / units.time)
 energy_stored = Symbol("energy_stored", units.energy)
@@ -30,10 +31,6 @@
 law = Eq(quality_factor, resonant_angular_frequency * (energy_stored / power_loss))
 
 
-def print_law() -> str:
-    return print_expression(law)
-
-
 @validate_input(
     resonant_angular_frequency_=resonant_angular_frequency,
     energy_stored_=energy_stored,

symplyphysics/laws/dynamics/deformation/bulk_modulus_via_young_modulus_and_poisson_ratio.py

@@ -13,6 +13,10 @@
 #. The :ref:`Poisson ratio <poisson-ratio>` :math:`\nu < \frac{1}{2}`,
    since :doc:`elastic energy density <laws.dynamics.deformation.elastic_energy_density_of_bulk_compression_via_pressure>`
    cannot be negative.
+
+**Links:**
+
+#. `Wikipedia, derivable from second part of the equation <https://en.wikipedia.org/wiki/Young%27s_modulus#Usage>`__.
 """
 
 from sympy import Eq

symplyphysics/laws/dynamics/deformation/elastic_energy_density_of_bulk_compression_via_pressure.py

@@ -5,6 +5,14 @@
 Volumetric density of the elastic energy of a body that is under bulk
 compression is proportional to the square of the pressure in the body
 and inversely proportional to the bulk modulus of the body's material.
+
+**Conditions:**
+
+#. The body undergoes bulk compression.
+
+**Links:**
+
+#. Formula 77.5 on p. 393 of "General Course of Physics" (Obschiy kurs fiziki), vol. 1 by Sivukhin D.V. (1979).
 """
 
 from sympy import Eq

symplyphysics/laws/dynamics/deformation/elastic_energy_density_of_compression_via_strain.py

@@ -6,6 +6,14 @@
 its Young's modulus and the square of its strain. The
 :doc:`Hooke's law <laws.dynamics.deformation.tensile_stress_is_youngs_modulus_times_strain>`
 can be used to obtain analogous forms of this law.
+
+**Conditions:**
+
+#. The material is linearly elastic.
+
+**Links:**
+
+#. `Wikipedia, equation on the fourth line <https://en.wikipedia.org/wiki/Young%27s_modulus#Elastic_potential_energy>`__.
 """
 
 from sympy import Eq

symplyphysics/laws/dynamics/deformation/engineering_normal_strain_is_total_deformation_over_initial_dimension.py

@@ -4,6 +4,10 @@
 
 *Engineering normal strain*, also called *Cauchy strain*, is expressed as the ratio of total
 deformation to the initial dimension of a material body on which forces are applied.
+
+**Links:**
+
+#. `Wikipedia <https://en.wikipedia.org/wiki/Strain_(mechanics)#Engineering_strain>`__.
 """
 
 from sympy import Eq

symplyphysics/laws/dynamics/deformation/poisson_ratio_is_transverse_to_axial_strain_ratio.py

@@ -11,6 +11,14 @@
    negative strain indicates contraction.
 #. The Poisson ratio and the Young modulus are all that is needed to completely
    describe elastic properties of an isotropic material.
+
+**Conditions:**
+
+#. The strains must be small.
+
+**Links:**
+
+#. `Wikipedia <https://en.wikipedia.org/wiki/Poisson%27s_ratio#Origin>`__.
 """
 
 from sympy import Eq

symplyphysics/laws/dynamics/deformation/pressure_is_maclaurin_series_of_strain.py

@@ -19,6 +19,10 @@
 #. The deformations are small, i.e. :math:`e \ll 1`.
 #. This law features the expansion up to the third power of strain, higher terms can be added
    if needed.
+
+**Links:**
+
+#. Section 3 on p. 385 of "General Course of Physics" (Obschiy kurs fiziki), vol. 1 by Sivukhin D.V. (1979).
 """
 
 from sympy import Eq, O

symplyphysics/laws/dynamics/deformation/rotational_stiffness_is_torque_over_angle.py

@@ -3,6 +3,10 @@
 =================================================
 
 *Rotational stiffness* is the extent to which an object resists rotational deformation.
+
+**Links:**
+
+#. `Wikipedia <https://en.wikipedia.org/wiki/Stiffness#Rotational_stiffness>`__.
 """
 
 from sympy import Eq

symplyphysics/laws/dynamics/deformation/shear_stress_is_shear_modulus_times_strain.py

@@ -4,7 +4,6 @@
     angle_type,
     Quantity,
     Symbol,
-    print_expression,
     validate_input,
     validate_output,
 )
@@ -26,17 +25,15 @@
 # Note
 ## For a visual representation of shear stress visit [this](https://vuzdoc.org/htm/img/3/6176/223.png)
 
+# Links: Wikipedia <https://en.wikipedia.org/wiki/Shear_stress#Pure>
+
 shear_stress = Symbol("shear_stress", units.pressure)
 shear_modulus = Symbol("shear_modulus", units.pressure)
 shear_strain = Symbol("shear_strain", angle_type)
 
 law = Eq(shear_stress, shear_modulus * shear_strain)
 
 
-def print_law() -> str:
-    return print_expression(law)
-
-
 @validate_input(
     shear_modulus_=shear_modulus,
     shear_strain_=shear_strain,

symplyphysics/laws/dynamics/deformation/superposition_of_small_deformations.py

@@ -9,6 +9,10 @@
 **Conditions:**
 
 #. The deformations are small.
+
+**Links:**
+
+#. `Wikipedia, general information can be found here <https://en.wikipedia.org/wiki/Infinitesimal_strain_theory>`__.
 """
 
 from sympy import Eq

symplyphysics/laws/dynamics/deformation/tensile_stress_is_youngs_modulus_times_strain.py

@@ -4,6 +4,10 @@
 
 When an object is under tension or compression, the stress is related to the strain via the
 Young's modulus.
+
+**Links:**
+
+#. `Wikipedia <https://en.wikipedia.org/wiki/Young%27s_modulus#Definition>`__.
 """
 
 from sympy import Eq

symplyphysics/laws/dynamics/fields/conservative_force_is_gradient_of_potential_energy.py

@@ -18,6 +18,8 @@
 # Conditions
 ## - Force is conservative (see definition above)
 
+# Links: Wikipedia <https://en.wikipedia.org/wiki/Conservative_force>
+
 
 def law(potential_: ScalarField) -> Vector:
     gradient_vector = gradient_operator(potential_)

symplyphysics/laws/dynamics/springs/compliance_of_two_serial_springs.py

@@ -3,7 +3,6 @@
     units,
     Quantity,
     Symbol,
-    print_expression,
     validate_input,
     validate_output,
 )
@@ -25,6 +24,8 @@
 # Condition
 ## - Springs must be Hookean, or linear-response, i.e. obey the Hooke's law.
 
+# Links: Wikipedia <https://en.wikipedia.org/wiki/Series_and_parallel_springs#Formulas>
+
 total_compliance = Symbol("total_compliance", units.length / units.force)
 first_compliance = Symbol("first_compliance", units.length / units.force)
 second_compliance = Symbol("second_compliance", units.length / units.force)
@@ -76,10 +77,6 @@
 assert expr_equals(_total_compliance_derived, law.rhs)
 
 
-def print_law() -> str:
-    return print_expression(law)
-
-
 @validate_input(
     first_compliance_=first_compliance,
     second_compliance_=second_compliance,

symplyphysics/laws/dynamics/springs/spring_reaction_is_proportional_to_deformation.py

@@ -33,6 +33,8 @@
 ##   be positive, in which case the spring is stretched, or negative, in which case the spring
 ##   is compressed. The sign of the force indicates its direction along the x-axis.
 
+# Links: Wikipedia, last formula in paragraph <https://en.wikipedia.org/wiki/Hooke%27s_law#Linear_springs>
+
 # Also see its [vector counterpart](../vector/spring_reaction_from_deformation.py)
 
 spring_reaction = symbols.force

symplyphysics/laws/dynamics/springs/stiffness_of_two_parallel_springs.py

@@ -3,7 +3,6 @@
     units,
     Quantity,
     Symbol,
-    print_expression,
     validate_input,
     validate_output,
     Vector,
@@ -24,6 +23,8 @@
 # Condition
 ## - Springs must be Hookean, or linear-response, i.e. obey the Hooke's law.
 
+# Links: Wikipedia <https://en.wikipedia.org/wiki/Series_and_parallel_springs#Formulas>
+
 total_stiffness = Symbol("total_stiffness", units.force / units.length, positive=True)
 first_stiffness = Symbol("first_stiffness", units.force / units.length, positive=True)
 second_stiffness = Symbol("second_stiffness", units.force / units.length, positive=True)
@@ -60,10 +61,6 @@
 assert expr_equals(_total_stiffness_derived, law.rhs)
 
 
-def print_law() -> str:
-    return print_expression(law)
-
-
 @validate_input(
     first_stiffness_=first_stiffness,
     second_stiffness_=second_stiffness,

symplyphysics/laws/hydro/dynamic_pressure_via_density_and_flow_speed.py

@@ -10,6 +10,10 @@
 
 #. Many authors define this quantity only for *incompressible flows*, but others extend it for
    compressible flows as well.
+
+**Links:**
+
+#. `Wikipedia <https://en.wikipedia.org/wiki/Dynamic_pressure>`__.
 """
 
 from sympy import (Eq, solve)

symplyphysics/laws/hydro/efficiency_of_the_hydraulic_press_from_force_and_height.py

@@ -5,7 +5,6 @@
     units,
     Quantity,
     Symbol,
-    print_expression,
     validate_input,
     validate_output,
     dimensionless,
@@ -23,6 +22,8 @@
 ## h1 is expended height
 ## n is coefficient of efficiency
 
+# TODO find link
+
 useful_force = clone_as_symbol(symbols.force, display_symbol="F_1", display_latex="F_1")
 useful_height = Symbol("useful_height", units.length)
 expended_force = clone_as_symbol(symbols.force, display_symbol="F_2", display_latex="F_2")
@@ -32,10 +33,6 @@
 law = Eq(efficiency, (useful_force * useful_height) / (expended_force * expended_height))
 
 
-def print_law() -> str:
-    return print_expression(law)
-
-
 @validate_input(useful_force_=useful_force,
     useful_height_=useful_height,
     expended_force_=expended_force,

symplyphysics/laws/hydro/efflux_speed_via_height.py

@@ -10,6 +10,10 @@
 #. The orifice is very small relative to the horizontal cross-section of the container.
 #. The fluid is :ref:`ideal <ideal_fluid_def>`.
 #. The fluid is subjected to the gravity force of Earth.
+
+**Links:**
+
+#. `Wikipedia <https://en.wikipedia.org/wiki/Torricelli%27s_law#>`__.
 """
 
 from sympy import (Eq, solve, sqrt)

symplyphysics/laws/hydro/efflux_speed_via_hydrostatic_pressure_and_density.py

@@ -10,6 +10,9 @@
 
 #. The orifice is very small relative to the horizontal cross-section of the container.
 #. The fluid is :ref:`ideal <ideal_fluid_def>`.
+
+..
+    TODO find link
 """
 
 from sympy import (Eq, solve, sqrt)