Beam

Beam

This is the subclass that implements a single beam.

Attributes:

Name	Type	Description
lmbda	float	wavelength of the beam (m)
direction	string	direction of the Beam. "f" for a forward beam, "b" for a bacward propagating beam.
power	float	power of the beam (W)

Note

The direction here is not used in the program, but we found it useful to keep in mind the physical system under study.

Examples:

To create an instance of the Beam class:

>>> BP = Beam(852e-9,"f",1*mW)

get_direction(self)

Getter function for the direction attribute

Returns:

Type	Description
str	direction of the beam

Source code in nanotrappy\trapping\beam.py

def get_direction(self):
    """Getter function for the direction attribute

    Returns:
        str: direction of the beam
    """
    return self.direction

get_lmbda(self)

Getter function for the lmbda attribute

Returns:

Type	Description
float	wavelength of the beam

Source code in nanotrappy\trapping\beam.py

def get_lmbda(self):
    """Getter function for the lmbda attribute

    Returns:
        float: wavelength of the beam
    """
    return self.lmbda

get_power(self)

Getter function for the power attribute

Returns:

Type	Description
float	power of the beam

Source code in nanotrappy\trapping\beam.py

def get_power(self):
    """Getter function for the power attribute

    Returns:
        float: power of the beam
    """
    return self.power

set_direction(self, direction)

Set the direction attribute of the beam.

Parameters:

Name	Type	Description	Default
direction	str	new direction to be set.	required

Source code in nanotrappy\trapping\beam.py

def set_direction(self, direction):
    """Set the direction attribute of the beam.

    Args:
        direction (str): new direction to be set.
    """
    self.direction = direction

set_lmbda(self, lmbda)

Set the wavelength attribute of the beam.

Parameters:

Name	Type	Description	Default
lmbda	float	new wavelength to be set (m)	required

Source code in nanotrappy\trapping\beam.py

def set_lmbda(self, lmbda):
    """Set the wavelength attribute of the beam.

    Args:
        lmbda (float): new wavelength to be set (m)
    """
    self.lmbda = lmbda

set_power(self, power)

Set the power attribute of the beam.

Parameters:

Name	Type	Description	Default
power	float	new power to be set (W)	required

Source code in nanotrappy\trapping\beam.py

def set_power(self, power):
    """Set the power attribute of the beam.

    Args:
        power (float): new power to be set (W)
    """
    self.power = power

BeamPair

This is the subclass that implements a single beam.

Attributes:

Name	Type	Description
lmbda1	float	wavelength of the first beam of the pair (m)
power1	float	power of the first beam of the pair (W)
lmbda2	float	wavelength of the second beam of the pair (m)
power2	float	power of the second beam of the pair (W)

Caution

Here the powers have to be the same for now. It would considerably slow the computation if not. We still put two args to mimic the physical system. We hope it will be implemented in the future.

Caution

The wavelengths do not have to be the same, but in the spirit of the current research, we limit the possible difference. This boundary wavelength_equality_tolerance can be modified if need in the utils.utils module.

Exceptions:

Type	Description
ValueError	if power1 not equal to power 2
ValueError	if |lmbda1-lmbda2| > wavelength_equality_tolerance

Examples:

To create an instance of the BeamPair class:

>>> BP = BeamPair(852e-9,"f",1*mW,852e-9,"f",1*mW)

get_lmbda(self)

Get the wavelengths of a BeamPair

Returns:

Type	Description
array	an array of the two wavelengths

Source code in nanotrappy\trapping\beam.py

def get_lmbda(self):
    """Get the wavelengths of a BeamPair

    Returns:
        array: an array of the two wavelengths
    """
    return np.array([self.beam1.lmbda, self.beam2.lmbda])

get_power(self)

Get the powers of a BeamPair

Returns:

Type	Description
float	power of the two beams

Caution

As the two powers have to be equal, this functions returns only one float.

Source code in nanotrappy\trapping\beam.py

def get_power(self):
    """Get the powers of a BeamPair

    Returns:
        float: power of the two beams

    Caution:
        As the two powers have to be equal, this functions returns only one float.
    """
    return self.beam1.power

set_lmbda(self, *args)

Set the wavelengths of a BeamPair

If a list is provided, the wavelengths are set idependently using this list. If a float is provided, the two wavelengths are set to be equal.

Parameters:

Name	Type	Description	Default
lmbdas	float	either a list of two values, or one value (m)	required

Exceptions:

Type	Description
ValueError	if |lmbda1-lmbda2| > wavelength_equality_tolerance
ValueError	if more than 2 wavelengths are provided

Source code in nanotrappy\trapping\beam.py

def set_lmbda(self, *args):
    """Set the wavelengths of a BeamPair

    If a list is provided, the wavelengths are set idependently using this list. 
    If a float is provided, the two wavelengths are set to be equal.

    Args:
        lmbdas (float): either a list of two values, or one value (m)

    Raise:
        ValueError: if |lmbda1-lmbda2| > wavelength_equality_tolerance
        ValueError: if more than 2 wavelengths are provided

    """
    if len(args) == 1 :
        self.beam1.lmbda = args[0]
        self.beam2.lmbda = args[0]
    elif len(args) == 2 :
        if abs(args[0]-args[1])<pu.wavelength_equality_tolerance:
            self.beam1.lmbda = args[0]
            self.beam2.lmbda = args[1]
        else:
            raise ValueError('Cannot set different values of wavelengths for a pair of beams.')
    else :
        raise ValueError("Too many values to unpack")

set_power(self, power)

Set the powers of a BeamPair

Only one power is needed as the powers have to be the same.

Parameters:

Name	Type	Description	Default
power	float	new power to be set for the two beams (W)	required

Source code in nanotrappy\trapping\beam.py

def set_power(self,power):
    """Set the powers of a BeamPair

    Only one power is needed as the powers have to be the same.

    Args:
        power (float): new power to be set for the two beams (W)

    """
    self.beam1.power = power
    self.beam2.power = power

Beams

This is the parent class that implements the beams.

It is used to define the general tests to distinguish between a Beam and a BeamPair.

Examples:

To test if a object object of type Beams is an instance of the subclass BeamPair:

>>> BP = BeamPair(852e-9,1*mW,852e-9,1*mW)
>>> BP.isBeam()
False
>>> BP.isBeamPair()
True

isBeam(self)

Checks if a Beams object is an instance of the Beam subclass.

Returns:

Type	Description
bool	True if the object is an instance of the Beam subclass

Source code in nanotrappy\trapping\beam.py

def isBeam(self):
    """Checks if a Beams object is an instance of the Beam subclass.

    Returns:
        bool: True if the object is an instance of the Beam subclass
    """
    if type(self).__name__ == "Beam":
        return True
    else:
        return False

isBeamPair(self)

Checks if a Beams object is an instance of the BeamPair subclass.

Returns:

Type	Description
bool	True if the object is an instance of the BeamPair subclass

Source code in nanotrappy\trapping\beam.py

def isBeamPair(self):
    """Checks if a Beams object is an instance of the BeamPair subclass.

    Returns:
        bool: True if the object is an instance of the BeamPair subclass
    """
    if type(self).__name__ == "BeamPair":
        return True
    else:
        return False