fipy.solvers package¶
- fipy.solvers.DefaultAsymmetricSolver¶
alias of
LinearGMRESSolver
- fipy.solvers.DefaultSolver¶
alias of
LinearGMRESSolver
- class fipy.solvers.DummySolver(*args, **kwargs)¶
Bases:
PETScSolver
Solver that doesn’t do anything.
PETSc is intolerant of having zeros on the diagonal
Create a Solver object.
- Parameters:
- __del__()¶
- __enter__()¶
- __exit__(exc_type, exc_value, traceback)¶
- __repr__()¶
Return repr(self).
- fipy.solvers.GeneralSolver¶
alias of
LinearGMRESSolver
- exception fipy.solvers.IllConditionedPreconditionerWarning(solver, iter, relres)¶
Bases:
PreconditionerWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- class fipy.solvers.LinearBicgSolver(tolerance=1e-10, iterations=1000, precon=None)¶
Bases:
PETScKrylovSolver
The LinearBicgSolver is an interface to the biconjugate gradient solver in PETSc, using no preconditioner by default.
- Parameters:
tolerance: The required error tolerance.
iterations: The maximum number of iterative steps to perform.
precon: Preconditioner to use (string).
- __del__()¶
- __enter__()¶
- __exit__(exc_type, exc_value, traceback)¶
- __repr__()¶
Return repr(self).
- solver = 'bicg'¶
- class fipy.solvers.LinearCGSSolver(tolerance=1e-10, iterations=1000, precon=None)¶
Bases:
PETScKrylovSolver
The LinearCGSSolver is an interface to the conjugate gradient squared solver in PETSc, using no preconditioner by default.
- Parameters:
tolerance: The required error tolerance.
iterations: The maximum number of iterative steps to perform.
precon: Preconditioner to use (string).
- __del__()¶
- __enter__()¶
- __exit__(exc_type, exc_value, traceback)¶
- __repr__()¶
Return repr(self).
- solver = 'cgs'¶
- class fipy.solvers.LinearGMRESSolver(tolerance=1e-10, iterations=1000, precon=None)¶
Bases:
PETScKrylovSolver
The LinearGMRESSolver is an interface to the GMRES solver in PETSc, using no preconditioner by default.
- Parameters:
tolerance: The required error tolerance.
iterations: The maximum number of iterative steps to perform.
precon: Preconditioner to use (string).
- __del__()¶
- __enter__()¶
- __exit__(exc_type, exc_value, traceback)¶
- __repr__()¶
Return repr(self).
- solver = 'gmres'¶
- class fipy.solvers.LinearLUSolver(tolerance=1e-10, iterations=10, precon='lu')¶
Bases:
PETScSolver
The LinearLUSolver is an interface to the LU preconditioner in PETSc. A direct solve is performed.
- Parameters:
tolerance: The required error tolerance.
iterations: The maximum number of iterative steps to perform.
precon: Ignored.
- __del__()¶
- __enter__()¶
- __exit__(exc_type, exc_value, traceback)¶
- __repr__()¶
Return repr(self).
- class fipy.solvers.LinearPCGSolver(tolerance=1e-10, iterations=1000, precon=None)¶
Bases:
PETScKrylovSolver
The LinearPCGSolver is an interface to the cg solver in PETSc, using no preconditioner by default.
- Parameters:
tolerance: The required error tolerance.
iterations: The maximum number of iterative steps to perform.
precon: Preconditioner to use (string).
- __del__()¶
- __enter__()¶
- __exit__(exc_type, exc_value, traceback)¶
- __repr__()¶
Return repr(self).
- solver = 'cg'¶
- exception fipy.solvers.MatrixIllConditionedWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.MaximumIterationWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.PreconditionerNotPositiveDefiniteWarning(solver, iter, relres)¶
Bases:
PreconditionerWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.PreconditionerWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.ScalarQuantityOutOfRangeWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- class fipy.solvers.Solver(tolerance=1e-10, iterations=1000, precon=None)¶
Bases:
object
The base LinearXSolver class.
Attention
This class is abstract. Always create one of its subclasses.
Create a Solver object.
- Parameters:
- __del__()¶
- __enter__()¶
- __exit__(exc_type, exc_value, traceback)¶
- __repr__()¶
Return repr(self).
- exception fipy.solvers.SolverConvergenceWarning(solver, iter, relres)¶
Bases:
Warning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.StagnatedSolverWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
Subpackages¶
- fipy.solvers.petsc package
DefaultAsymmetricSolver
DefaultSolver
DummySolver
GeneralSolver
LinearBicgSolver
LinearCGSSolver
LinearGMRESSolver
LinearLUSolver
LinearPCGSolver
- Subpackages
- Submodules
- fipy.solvers.petsc.dummySolver module
- fipy.solvers.petsc.linearBicgSolver module
- fipy.solvers.petsc.linearCGSSolver module
- fipy.solvers.petsc.linearGMRESSolver module
- fipy.solvers.petsc.linearLUSolver module
- fipy.solvers.petsc.linearPCGSolver module
- fipy.solvers.petsc.petscKrylovSolver module
- fipy.solvers.petsc.petscSolver module
- fipy.solvers.pyAMG package
DefaultAsymmetricSolver
DefaultSolver
DummySolver
GeneralSolver
LinearCGSSolver
LinearGMRESSolver
LinearGeneralSolver
LinearLUSolver
LinearPCGSolver
- Subpackages
- Submodules
- fipy.solvers.pyAMG.linearCGSSolver module
- fipy.solvers.pyAMG.linearGMRESSolver module
- fipy.solvers.pyAMG.linearGeneralSolver module
- fipy.solvers.pyAMG.linearLUSolver module
- fipy.solvers.pyAMG.linearPCGSolver module
- fipy.solvers.pyamgx package
AggregationAMGSolver
DefaultAsymmetricSolver
DefaultSolver
DummySolver
GeneralSolver
LinearBiCGStabSolver
LinearCGSolver
LinearFGMRESSolver
LinearLUSolver
LinearPCGSolver
- Subpackages
- Submodules
- fipy.solvers.pyamgx.aggregationAMGSolver module
- fipy.solvers.pyamgx.classicalAMGSolver module
- fipy.solvers.pyamgx.linearBiCGStabSolver module
- fipy.solvers.pyamgx.linearCGSolver module
- fipy.solvers.pyamgx.linearFGMRESSolver module
- fipy.solvers.pyamgx.linearGMRESSolver module
- fipy.solvers.pyamgx.linearLUSolver module
- fipy.solvers.pyamgx.pyAMGXSolver module
- fipy.solvers.pysparse package
- fipy.solvers.scipy package
DefaultAsymmetricSolver
DefaultSolver
DummySolver
GeneralSolver
LinearBicgstabSolver
LinearCGSSolver
LinearGMRESSolver
LinearLUSolver
LinearPCGSolver
- Submodules
- fipy.solvers.scipy.linearBicgstabSolver module
- fipy.solvers.scipy.linearCGSSolver module
- fipy.solvers.scipy.linearGMRESSolver module
- fipy.solvers.scipy.linearLUSolver module
- fipy.solvers.scipy.linearPCGSolver module
- fipy.solvers.scipy.scipyKrylovSolver module
- fipy.solvers.scipy.scipySolver module
- fipy.solvers.trilinos package
- Subpackages
- fipy.solvers.trilinos.comms package
- fipy.solvers.trilinos.preconditioners package
- Submodules
- fipy.solvers.trilinos.preconditioners.domDecompPreconditioner module
- fipy.solvers.trilinos.preconditioners.icPreconditioner module
- fipy.solvers.trilinos.preconditioners.jacobiPreconditioner module
- fipy.solvers.trilinos.preconditioners.multilevelDDMLPreconditioner module
- fipy.solvers.trilinos.preconditioners.multilevelDDPreconditioner module
- fipy.solvers.trilinos.preconditioners.multilevelNSSAPreconditioner module
- fipy.solvers.trilinos.preconditioners.multilevelSAPreconditioner module
- fipy.solvers.trilinos.preconditioners.multilevelSGSPreconditioner module
- fipy.solvers.trilinos.preconditioners.multilevelSolverSmootherPreconditioner module
- fipy.solvers.trilinos.preconditioners.preconditioner module
- Submodules
- fipy.solvers.trilinos.linearBicgstabSolver module
- fipy.solvers.trilinos.linearCGSSolver module
- fipy.solvers.trilinos.linearGMRESSolver module
- fipy.solvers.trilinos.linearLUSolver module
- fipy.solvers.trilinos.linearPCGSolver module
- fipy.solvers.trilinos.trilinosAztecOOSolver module
- fipy.solvers.trilinos.trilinosMLTest module
- fipy.solvers.trilinos.trilinosNonlinearSolver module
- fipy.solvers.trilinos.trilinosSolver module
- Subpackages
Submodules¶
fipy.solvers.pysparseMatrixSolver module¶
fipy.solvers.solver module¶
The iterative solvers may output warnings if the solution is considered unsatisfactory. If you are not interested in these warnings, you can invoke python with a warning filter such as:
$ python -Wignore::fipy.SolverConvergenceWarning myscript.py
If you are extremely concerned about your preconditioner for some reason, you can abort whenever it has problems with:
$ python -Werror::fipy.PreconditionerWarning myscript.py
- exception fipy.solvers.solver.IllConditionedPreconditionerWarning(solver, iter, relres)¶
Bases:
PreconditionerWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.solver.MatrixIllConditionedWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.solver.MaximumIterationWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.solver.PreconditionerNotPositiveDefiniteWarning(solver, iter, relres)¶
Bases:
PreconditionerWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.solver.PreconditionerWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.solver.ScalarQuantityOutOfRangeWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- class fipy.solvers.solver.Solver(tolerance=1e-10, iterations=1000, precon=None)¶
Bases:
object
The base LinearXSolver class.
Attention
This class is abstract. Always create one of its subclasses.
Create a Solver object.
- Parameters:
- __del__()¶
- __enter__()¶
- __exit__(exc_type, exc_value, traceback)¶
- __repr__()¶
Return repr(self).
- exception fipy.solvers.solver.SolverConvergenceWarning(solver, iter, relres)¶
Bases:
Warning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception fipy.solvers.solver.StagnatedSolverWarning(solver, iter, relres)¶
Bases:
SolverConvergenceWarning
- __cause__¶
exception cause
- __context__¶
exception context
- __delattr__(name, /)¶
Implement delattr(self, name).
- __getattribute__(name, /)¶
Return getattr(self, name).
- __reduce__()¶
Helper for pickle.
- __repr__()¶
Return repr(self).
- __setattr__(name, value, /)¶
Implement setattr(self, name, value).
- __setstate__()¶
- __str__()¶
Return str(self).
- __suppress_context__¶
- __traceback__¶
- add_note()¶
Exception.add_note(note) – add a note to the exception
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.