Referencia de la clase dirac_solver.core.DiracProblemBuilder

Implementación del patrón Builder para crear objetos SimulationProblem. Más...

Métodos públicos
	__init__ (self)
	set_grid (self, Grid grid)
	Define la malla espacial a utilizar.
	set_initial_state (self, GaussianPacket initial_state)
	Define el estado inicial del campo espinorial.
	set_potential (self, potential)
	Define el potencial escalar.
	set_boundary_condition (self, boundary_condition)
	Define la condición de borde.
	set_time_parameters (self, float time_step, float total_time)
	Define los parámetros de tiempo de la simulación.
SimulationProblem	build (self)
	Construye el objeto SimulationProblem con los parámetros actuales.

Atributos protegidos
	_grid
	_initial_state
	_potential
	_boundary_condition
	_time_step
	_total_time

Descripción detallada

Implementación del patrón Builder para crear objetos SimulationProblem.

Esta clase ofrece una interfaz fluida para configurar los componentes de una simulación del ecuación de Dirac. Facilita el proceso de validación y permite un flujo de construcción más legible.

Ejemplo de uso:

builder = DiracProblemBuilder()
problem = (builder
          .set_grid(my_grid)
          .set_initial_state(my_packet)
          .set_potential(V)
          .set_boundary_condition("absorbing")
          .set_time_parameters(dt, T)
          .build())

Documentación de constructores y destructores

__init__()

dirac_solver.core.DiracProblemBuilder.__init__

(

self

)

    def __init__(self):
        self._grid = None
        self._initial_state = None
        self._potential = None
        self._boundary_condition = None
        self._time_step = None
        self._total_time = None
 

Documentación de funciones miembro

build()

SimulationProblem dirac_solver.core.DiracProblemBuilder.build

(

self

)

Construye el objeto SimulationProblem con los parámetros actuales.

Devuelve

Instancia de SimulationProblem.

Excepciones

ValueError

Si algún parámetro requerido no fue establecido.

Atención

Si el potencial no fue definido, se asume partícula libre (V=0).

    def build(self) -> SimulationProblem:
        if self._grid is None:
            raise ValueError("La malla debe ser establecida antes de construir el problema.")
        if self._initial_state is None:
            raise ValueError("El estado inicial debe ser establecido antes de construir.")
        if self._time_step is None or self._total_time is None:
            raise ValueError("Los parámetros de tiempo deben ser establecidos.")
        if self._boundary_condition is None:
            raise ValueError("La condición de borde debe ser establecida.")
 
        if self._potential is None:
            print("Advertencia: Potencial no establecido. Usando partícula libre (V=0) por defecto.")
 
        return SimulationProblem(
            grid=self._grid,
            initial_state=self._initial_state,
            potential=self._potential,
            boundary_condition=self._boundary_condition,
            time_step=self._time_step,
            total_time=self._total_time,
        )
 
 

set_boundary_condition()

dirac_solver.core.DiracProblemBuilder.set_boundary_condition	(		self,
			boundary_condition
	)

Define la condición de borde.

Parámetros

boundary_condition

Cadena o estructura que especifica el tipo de condición (e.g. "absorbing").

Devuelve

Referencia al propio builder.

    def set_boundary_condition(self, boundary_condition):
        self._boundary_condition = boundary_condition
        return self
 

set_grid()

dirac_solver.core.DiracProblemBuilder.set_grid	(		self,
		Grid	grid
	)

Define la malla espacial a utilizar.

Parámetros

grid	Objeto Grid que describe el dominio espacial.

Devuelve

Referencia al propio builder para encadenamiento de métodos.

    def set_grid(self, grid: Grid):
        self._grid = grid
        return self
 

set_initial_state()

dirac_solver.core.DiracProblemBuilder.set_initial_state	(		self,
		GaussianPacket	initial_state
	)

Define el estado inicial del campo espinorial.

Parámetros

initial_state

Instancia de GaussianPacket u otro estado inicial compatible.

Devuelve

Referencia al propio builder.

    def set_initial_state(self, initial_state: GaussianPacket):
        self._initial_state = initial_state
        return self
 

set_potential()

dirac_solver.core.DiracProblemBuilder.set_potential	(		self,
			potential
	)

Define el potencial escalar.

Parámetros

potential

Potencial espacialmente dependiente o constante (puede ser None).

Devuelve

Referencia al propio builder.

    def set_potential(self, potential):
        self._potential = potential
        return self
 

set_time_parameters()

dirac_solver.core.DiracProblemBuilder.set_time_parameters	(		self,
		float	time_step,
		float	total_time
	)

Define los parámetros de tiempo de la simulación.

Parámetros

time_step	Paso de tiempo (Δt) utilizado por el integrador.
total_time	Tiempo total de evolución.

Devuelve

Referencia al propio builder.

    def set_time_parameters(self, time_step: float, total_time: float):
        self._time_step = time_step
        self._total_time = total_time
        return self
 

Documentación de datos miembro

_boundary_condition

dirac_solver.core.DiracProblemBuilder._boundary_condition

protected

_grid

dirac_solver.core.DiracProblemBuilder._grid

protected

_initial_state

dirac_solver.core.DiracProblemBuilder._initial_state

protected

_potential

dirac_solver.core.DiracProblemBuilder._potential

protected

_time_step

dirac_solver.core.DiracProblemBuilder._time_step

protected

_total_time

dirac_solver.core.DiracProblemBuilder._total_time

protected

---

La documentación de esta clase está generada del siguiente archivo:

• dirac_solver/core.py