Remove code duplication for relativistic factor

There are currently two independent implementations that calculate the relativistic factors $\gamma$ and $\beta$. It would probably be best to reconsile them to avoid inconsistencies down the line.

cheetah/cheetah/particles/beam.py

Lines 357 to 369 in 71c3350

    
           @property 
        
           def relativistic_gamma(self) -> torch.Tensor: 
        
               """Reference relativistic gamma of the beam.""" 
        
               return self.energy / self.species.mass_eV 
        
           @property 
        
           def relativistic_beta(self) -> torch.Tensor: 
        
               """Reference relativistic beta of the beam.""" 
        
               relativistic_beta = torch.ones_like(self.relativistic_gamma) 
        
               relativistic_beta[torch.abs(self.relativistic_gamma) > 0] = torch.sqrt( 
        
                   1 - 1 / (self.relativistic_gamma[self.relativistic_gamma > 0] ** 2) 
        
               ) 
        
               return relativistic_beta

cheetah/cheetah/utils/physics.py

Lines 4 to 19 in 71c3350

    
           def compute_relativistic_factors( 
        
               energy: torch.Tensor, particle_mass_eV: torch.Tensor 
        
           ) -> tuple[torch.Tensor, torch.Tensor, torch.Tensor]: 
        
               """ 
        
               Computes the relativistic factors gamma, inverse gamma squared and beta for 
        
               particles. 
        
               :param energy: Energy in eV. 
        
               :param particle_mass_eV: Mass of the particle in eV. 
        
               :return: gamma, igamma2, beta. 
        
               """ 
        
               gamma = energy / particle_mass_eV 
        
               igamma2 = torch.where(gamma == 0.0, 0.0, 1 / gamma**2) 
        
               beta = torch.sqrt(1 - igamma2) 
        
               return gamma, igamma2, beta

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	@property
	def relativistic_gamma(self) -> torch.Tensor:
	"""Reference relativistic gamma of the beam."""
	return self.energy / self.species.mass_eV

	@property
	def relativistic_beta(self) -> torch.Tensor:
	"""Reference relativistic beta of the beam."""
	relativistic_beta = torch.ones_like(self.relativistic_gamma)
	relativistic_beta[torch.abs(self.relativistic_gamma) > 0] = torch.sqrt(
	1 - 1 / (self.relativistic_gamma[self.relativistic_gamma > 0] ** 2)
	)
	return relativistic_beta

	def compute_relativistic_factors(
	energy: torch.Tensor, particle_mass_eV: torch.Tensor
	) -> tuple[torch.Tensor, torch.Tensor, torch.Tensor]:
	"""
	Computes the relativistic factors gamma, inverse gamma squared and beta for
	particles.

	:param energy: Energy in eV.
	:param particle_mass_eV: Mass of the particle in eV.
	:return: gamma, igamma2, beta.
	"""
	gamma = energy / particle_mass_eV
	igamma2 = torch.where(gamma == 0.0, 0.0, 1 / gamma**2)
	beta = torch.sqrt(1 - igamma2)

	return gamma, igamma2, beta

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions