From 5d3330adc52bf5dd0a8d7f8a60e32b7aa6b13766 Mon Sep 17 00:00:00 2001
From: nikhitha79 <115790230+nikhitha79@users.noreply.github.com>
Date: Tue, 15 Oct 2024 11:45:42 +0530
Subject: [PATCH 1/2] Update photoelectric_effect.py

added work function calculation
---
 physics/photoelectric_effect.py | 37 +++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/physics/photoelectric_effect.py b/physics/photoelectric_effect.py
index 3a0138ffe045..4d33b14e2984 100644
--- a/physics/photoelectric_effect.py
+++ b/physics/photoelectric_effect.py
@@ -59,7 +59,44 @@ def maximum_kinetic_energy(
     if in_ev:
         return max(PLANCK_CONSTANT_EVS * frequency - work_function, 0)
     return max(PLANCK_CONSTANT_JS * frequency - work_function, 0)
+def work_function(
+    frequency: float, kinetic_energy: float, in_ev: bool = False
+) -> float:
+    """
+    Calculates the work function of a surface using the given
+    frequency and kinetic energy.
+
+    Parameters:
+        frequency (float): Frequency of the electromagnetic wave.
+        kinetic_energy (float): Kinetic energy of emitted electron.
+        in_ev (bool, optional): True if frequency and
+        kinetic energy are in eV.
+
+    Returns:
+        float: The calculated work function of the surface.
 
+    Raises:
+        ValueError: If the frequency is negative.
+
+    Usage example:
+    >>> work_function(1e6, 2)
+    -6.62607015e-28
+    >>> work_function(1e6, 2, True)
+    -8.271335392e-09
+    >>> work_function(1e16, 39.357, True)
+    24.542
+    >>> work_function(-9, 20)
+    Traceback (most recent call last):
+        ...
+    ValueError: Frequency can't be negative.
+    """
+
+    if frequency < 0:
+        raise ValueError("Frequency can't be negative.")
+
+    if in_ev:
+        return PLANCK_CONSTANT_EVS * frequency - kinetic_energy
+    return PLANCK_CONSTANT_JS * frequency - kinetic_energy
 
 if __name__ == "__main__":
     import doctest

From b3a134b092b08e7bd3038b4fbd76cef24321cc5c Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Tue, 15 Oct 2024 06:16:42 +0000
Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
---
 physics/photoelectric_effect.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/physics/photoelectric_effect.py b/physics/photoelectric_effect.py
index 4d33b14e2984..ec2802535f57 100644
--- a/physics/photoelectric_effect.py
+++ b/physics/photoelectric_effect.py
@@ -59,6 +59,8 @@ def maximum_kinetic_energy(
     if in_ev:
         return max(PLANCK_CONSTANT_EVS * frequency - work_function, 0)
     return max(PLANCK_CONSTANT_JS * frequency - work_function, 0)
+
+
 def work_function(
     frequency: float, kinetic_energy: float, in_ev: bool = False
 ) -> float:
@@ -98,6 +100,7 @@ def work_function(
         return PLANCK_CONSTANT_EVS * frequency - kinetic_energy
     return PLANCK_CONSTANT_JS * frequency - kinetic_energy
 
+
 if __name__ == "__main__":
     import doctest