num_ops::calc_zero_hh Interface Reference

Finds the zero of a function using Householder iteration. More...

Public Member Functions
character(len=max_str_ln) function	calc_zero_hh_0d (zero, fun, ord, guess, max_nr_backtracks, output)
	0-D version
character(len=max_str_ln) function	calc_zero_hh_3d (dims, zero, fun, ord, guess, max_nr_backtracks, output)
	3-D version

Detailed Description

Finds the zero of a function using Householder iteration.

If something goes wrong, by default multiple tries can be attempted, by backtracking on the correction by multiplying it by a relaxation factor. This can be done max_nr_backtracks times.

If still nothing is achieved, an error message is returned, that is empty otherwise.

Definition at line 35 of file num_ops.f90.

Member Function/Subroutine Documentation

calc_zero_hh_0d()

character(len=max_str_ln) function num_ops::calc_zero_hh::calc_zero_hh_0d	(	real(dp), intent(inout)	zero,
		external real(dp) function(real(dp), intent(in) x, integer, intent(in) ord)	fun,
		integer, intent(in)	ord,
		real(dp), intent(in)	guess,
		integer, intent(in), optional	max_nr_backtracks,
		logical, intent(in), optional	output )

0-D version

Parameters

[in,out]	fun	fun(x,ord) with x abscissa ord order of derivative fun ordinate
[in,out]	zero	output
[in]	ord	order of solution
[in]	guess	first guess
[in]	max_nr_backtracks	max nr. of tries with different relaxation factors
[in]	output	give output on convergence

Returns

possible error message

Definition at line 48 of file num_ops.f90.

Here is the call graph for this function:

calc_zero_hh_3d()

character(len=max_str_ln) function num_ops::calc_zero_hh::calc_zero_hh_3d	(	integer, dimension(3), intent(in)	dims,
		real(dp), dimension(dims(1),dims(2),dims(3)), intent(inout)	zero,
		external real(dp) function, dimension(dims(1),dims(2),dims(3))(integer, dimension(3), intent(in) dims, real(dp), dimension(dims(1),dims(2),dims(3)), intent(in) x, integer, intent(in) ord)	fun,
		integer, intent(in)	ord,
		real(dp), dimension(dims(1),dims(2),dims(3)), intent(in)	guess,
		integer, intent(in), optional	max_nr_backtracks,
		logical, intent(in), optional	output )

3-D version

Parameters

[in,out]	fun	fun(dims,x,ord) with dims(3) dimension of abscissa and ordinate x(dims(1),dims(2),dims(3)) abscissa ord order of derivative fun(dims(1),dims(2),dims(3)) ordinate
[in]	dims	dimensions of the problem
[in,out]	zero	output
[in]	ord	order of solution
[in]	guess	first guess
[in]	max_nr_backtracks	max nr. of backtracks
[in]	output	give output on convergence

Returns

possible error message

Definition at line 241 of file num_ops.f90.

Here is the call graph for this function:

---

The documentation for this interface was generated from the following file:

• /Users/toonweyens/Code/PB3D/Modules/num_ops.f90