x_prime
: vmec_equilibrium::vmec_magnetic_cache
+x_var
+: gradient_descent::gradient_descent_class
+
xc
: vmec_context::vmec_context_class
diff --git a/docs/gradient__descent_8f.html b/docs/gradient__descent_8f.html
new file mode 100644
index 0000000..5918a91
--- /dev/null
+++ b/docs/gradient__descent_8f.html
@@ -0,0 +1,148 @@
+
+
+
+Stellarator-Tools: LIBSTELL/Sources/Modules/gradient_descent.f File Reference
+
+
+
+
+
+
+ Stellarator-Tools
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Contains module gradient_descent .
+More...
+
+module gradient_descent Module is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path.
+
+
Contains module gradient_descent .
+
+
C fftpack::cftrig C system_mod::chdir C fourier::check Interface for checking results of the unit tests C integration_path::check Interface for checking the results of the unit tests C read_response::clresfun C read_response_nompi::clresfun C commandline_parser A radial quantity C vmec_test::commandline_parser A radial quantity C commandline_parser::commandline_parser_class Base class containing a parsed commandline C compression::compression_class Base class containing buffers for compressed and uncompressed data C compression::compression_construct Interface for the construction of compression_class types using compression_construct_new or compression_construct_netcdf C compression::compression_pointer Pointer to a compression object. Used for creating arrays of compression pointers. This is needed because fortran does not allow arrays of pointers directly C parallel_vmec_module::copylastntype C pspline_calls::cspeval C pspline_calls::cspevfn C pspline_calls::cspevx C pspline_calls::cspline C pspline_calls::cubsplb C utilities::curl_htof Interface to take the curl on a half mesh quantity and return a full mesh using either curl_htof or curl_htof_targ C cyl_flux::cyl_flux_context Structure to house needed internal state for cyl2flux C diagnostic_cdf::diagnostic_cdf_define C diagnostic_cdf::diagnostic_cdf_read C diagnostic_cdf::diagnostic_cdf_write C diagnostic_t::diagnostic_construct C diagnostic_t::diagnostic_desc C diagnostic_t::diagnostic_destroy C diagnostic_dot::diagnostic_dot_coil A single coil. A coil set is structured as a singly linked list C diagnostic_t::diagnostic_write C pspline_calls::dnherm1 C pspline_calls::dnherm2 C pspline_calls::dnherm3 C emission::emission_class Base class representing the soft x-ray emission function C emission::emission_construct ► C equilibrium::equilibrium_class Base class representing a equilibrium C vacuum_equilibrium::vacuum_class Base class representing a vacuum_equilibrium ► C vmec_equilibrium::vmec_class Base class representing a vmec_equilibrium C siesta_equilibrium::siesta_class Base class representing a siesta_equilibrium C equilibrium::equilibrium_construct Interface for the construction of equilibrium_class types using equilibrium_construct_vmec, equilibrium_construct_vacuum or equilibrium_construct_siesta C pspline_calls::evbicub C pspline_calls::evintrp2d C pspline_calls::evintrp3d C pspline_calls::evspline C pspline_calls::evtricub C extcurz_t::extcurz_desc C ezspline::ezhybrid_init C ezspline::ezlinear_init C ezspline_type::ezspline1_r4 C ezspline_type::ezspline1_r8 C ezspline_type::ezspline2_r4 C ezspline_type::ezspline2_r8 C ezspline_type::ezspline3_r4 C ezspline_type::ezspline3_r8 C ezspline::ezspline_2netcdf C ezspline_obj::ezspline_allocated C ezspline::ezspline_derivative C ezspline::ezspline_free C ezspline::ezspline_gradient C ezspline::ezspline_init C ezspline::ezspline_interp C ezspline::ezspline_isgridregular C ezspline::ezspline_isindomain C ezspline::ezspline_load C ezspline::ezspline_modulo C ezspline_obj::ezspline_preinit C ezspline::ezspline_save C ezspline::ezspline_setup C pspline_calls::f2test C pspline_calls::f3test C fftpack::fact C fftpack::fftfax C fftpack::fftrig C fourier::fourier_class Base class containing fourier memory C pspline_calls::fvbicub C pspline_calls::fvbicubx C pspline_calls::fvintrp2d C pspline_calls::fvintrp3d C pspline_calls::fvspline C pspline_calls::fvtricub C pspline_calls::fvtricubx C hessian::gather_array C guassian_process::gaussp_class Base class representing a gaussian process C guassian_process::gaussp_class_pointer Pointer to a gaussian process object. Used for creating arrays of gaussian process pointers. This is needed because fortran does not allow arrays of pointers directly C pspline_calls::genxpkg C vmec_utils::getbcyl C system_mod::getenv C vmec_utils::getjcyl C system_mod::getpid C gmres_lib::gmres_info C utilities::gradienthalf Interface to take the gradianet from full to half mesh using either GradientHalf or GradientHalf_p C pspline_calls::gridbicub C pspline_calls::gridherm1 C pspline_calls::gridherm2 C pspline_calls::gridherm3 C pspline_calls::gridintrp2d C pspline_calls::gridintrp3d C pspline_calls::gridpc1 C pspline_calls::gridpc2 C pspline_calls::gridpc3 C pspline_calls::gridspline C pspline_calls::gridtricub C pspline_calls::herm1ev C pspline_calls::herm1fcn C pspline_calls::herm1x C pspline_calls::herm2ev C pspline_calls::herm2fcn C pspline_calls::herm2fcnx C pspline_calls::herm2xy C pspline_calls::herm3ev C pspline_calls::herm3fcn C pspline_calls::herm3fcnx C pspline_calls::herm3xyz C pspline_calls::ibc_ck C integration_path_context::integration_function Interface for the integration function ► C integration_path::integration_path_class Base class containing the parameters of the integration method to use ► C integration_path::integration_path_gleg_class Subclass to use Gauss Legendre Quadrature C integration_path::integration_path_hp_glep_class Subclass to use hp approch ► C integration_path_context::integration_path_context_class Integration context object interface C integration_path::test_context A type for the test cases C intpol::intpol_gp_int_context_i Structure to hold all memory needed to be sent to the guassian process callback function of a point C intpol::intpol_gp_int_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C intpol::intpol_gp_int_context_x Structure to hold all memory needed to be sent to the guassian process callback function for position C intpol::intpol_gp_pol_context_i Structure to hold all memory needed to be sent to the guassian process callback function of a point C intpol::intpol_gp_pol_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C intpol::intpol_gp_pol_context_x Structure to hold all memory needed to be sent to the guassian process callback function for position C intpol::intpol_int_context Struture to hole all memort needed to be sent to the integration callback function C intpol::intpol_pol_context Struture to hole all memort needed to be sent to the integration callback function ► C sxrem::sxrem_context Structure to hold all memory needed to be sent to the callback function ► C sxrem::sxrem_gp_context_i Structure to hold all memory needed to be sent to the guassian process callback function for point C sxrem::sxrem_gp_ti_context_i Structure to hold all memory needed to be sent to the guassian process callback function for point ► C sxrem::sxrem_gp_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem::sxrem_gp_ti_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal ► C sxrem::sxrem_gp_context_x Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem::sxrem_gp_ti_context_x Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem::sxrem_ti_context Structure to hold all memory needed to be sent to the callback function C ipch_t::ipch_desc C blocktridiagonalsolver::levelelement Data associated with each row at each level C blocktridiagonalsolver_bst::levelelement Data associated with each row at each level C liprec::li_gbfa C liprec::li_gbsl C liprec::li_gefa C liprec::li_gesl C m_grid::m_grid_class Base class representing a m grid. This is grid contains information about the vacuum fields C vertex_list::magfield C magnetic_response::magnetic_response_class Base class representing a magnetic signal response function C magnetic_response::magnetic_response_construct Interface for the construction of magnetic_response_class types using magnetic_response_construct_new , & magnetic_response_construct_point or & magnetic_response_construct_netcdf C blocktridiagonalsolver::mastertoslavemapping Master-to-slave mapping C blocktridiagonalsolver_bst::mastertoslavemapping Master-to-slave mapping C mddc_cdf::mddc_cdf_define C mddc_cdf::mddc_cdf_read C mddc_cdf::mddc_cdf_write C mddc_t::mddc_construct C mddc_t::mddc_desc C mddc_t::mddc_destroy C mddc_t::mddc_mrf C mddc_t::mddc_write C pspline_calls::mkbicon C pspline_calls::mkbicop C pspline_calls::mkbicub C pspline_calls::mkbicubw C pspline_calls::mkherm1 C pspline_calls::mkherm2 C pspline_calls::mkherm3 C pspline_calls::mkintrp2d C pspline_calls::mkintrp3d C pspline_calls::mkspl2p C pspline_calls::mkspl2pb C pspline_calls::mkspl2z C pspline_calls::mkspl2zb C pspline_calls::mkspl3pb C pspline_calls::mkspl3zb C pspline_calls::mkspline C pspline_calls::mktricon C pspline_calls::mktricop C pspline_calls::mktricub C pspline_calls::mktricubw C model::model_class Base class representing a model C vmec_utils::mse_pitch C netcdf_inc::nf_close Interface to open a file C netcdf_inc::nf_create Interface to open a file C netcdf_inc::nf_def_dim Interface to define a dimension C netcdf_inc::nf_enddef Interface to inquire a dimension id C netcdf_inc::nf_get_var_double Interface for reading double variables C netcdf_inc::nf_get_var_int Interface for reading integer variables C netcdf_inc::nf_get_var_real Interface for reading real variables. Note double 2D array used by complex real array values C netcdf_inc::nf_inq_dimid Interface to inquire a dimension id C netcdf_inc::nf_inq_varid Interface to inquire a variable id C netcdf_inc::nf_open Interface to open a file C netcdf_inc::nf_put_var_double Interface for writing double variables C netcdf_inc::nf_put_var_int Interface for writing integer variables C netcdf_inc::nf_put_var_real Interface for writing real variables. Note double 2D array used by complex real array values C netcdf_inc::nf_put_vara_double Interface for reading double variables. Note double 2D array used by complex double array values C netcdf_inc::nf_put_vara_int Interface for writing integer variables C netcdf_inc::nf_put_vara_real Interface for reading real variables. Note double 2D array used by complex real array values C netcdf_inc::nf_strerror Interface to inquire a dimension id C pspline_calls::nspline C v3fit_params::param_class Base class representing a reconstructed parameter. An upper and lower bound may be set for the parameter value C v3fit_params::param_construct Interface for the construction of param_class types using param_construct_basic or param_construct_recon C v3fit_params::param_locking_class Class to hold variables needed when a parameter is a locking parameter. The locking parameter coefficents are stored in the correlation array of the parent type C v3fit_params::param_pointer Pointer to a parameter object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly C v3fit_params::param_recon_class Class to hold variables needed when a parameter is a reconstruction parameter C v3fit_params::param_write_step_data Interface for the writting of param_class data to the result file using param_write_step_data_1 or param_write_step_data_2 ► C parity Parity function interface C cosine Cosine Parity function interface C sine Sine Parity function interface C integration_path::path_construct Construction interface using path_construct_vertex C integration_path::path_destruct Destruct interface using path_destruct_vertex C vertex_list::pbfield C blocktridiagonalsolver::pblaslevelparameters Level-specific PBLAS information C blocktridiagonalsolver_bst::pblaslevelparameters Level-specific PBLAS information C blocktridiagonalsolver::pblasstats C blocktridiagonalsolver_bst::pblasstats C blocktridiagonalsolver::pblastemparray C blocktridiagonalsolver_bst::pblastemparray C pspline_calls::pc1ev C pspline_calls::pc1fcn C pspline_calls::pc2ev C pspline_calls::pc2fcn C pspline_calls::pc2fcnx C pspline_calls::pc3ev C pspline_calls::pc3fcn C pspline_calls::pc3fcnx C vertex_list::point C pprofile_t::pprofile_class Base class representing a parameterized profile C pprofile_t::pprofile_pointer Pointer to a pprofile object. Used for creating arrays of pprofile pointers. This is needed because fortran does not allow arrays of pointers directly C read_response::prfun C read_response_nompi::prfun C primed_grid::primed_grid_class Base class representing a primed grid. This is grid the volume integral will be summed over C profiler::profiler_bucket Full table of profiled functions C pspline_calls::pspline C system_mod::putenv C vertex_list::pvertex C system_mod::pxffork C system_mod::pxfwait C pspline_calls::r8akherm0 C pspline_calls::r8akherm1 C pspline_calls::r8akherm1p C pspline_calls::r8akherm2 C pspline_calls::r8akherm2p C pspline_calls::r8akherm3 C pspline_calls::r8akherm3p C pspline_calls::r8bcspeval C pspline_calls::r8bcspevfn C pspline_calls::r8bcspevxy C pspline_calls::r8bcspgrid C pspline_calls::r8bcspline C pspline_calls::r8bcspvec C pspline_calls::r8bpsplinb C pspline_calls::r8bpspline C pspline_calls::r8cspeval C pspline_calls::r8cspevfn C pspline_calls::r8cspevx C pspline_calls::r8cspline C pspline_calls::r8cubsplb C pspline_calls::r8dnherm1 C pspline_calls::r8dnherm2 C pspline_calls::r8dnherm3 C pspline_calls::r8evbicub C pspline_calls::r8evintrp2d C pspline_calls::r8evintrp3d C pspline_calls::r8evspline C pspline_calls::r8evtricub C pspline_calls::r8f2test C pspline_calls::r8f3test C pspline_calls::r8fvbicub C pspline_calls::r8fvbicubx C pspline_calls::r8fvintrp2d C pspline_calls::r8fvintrp3d C pspline_calls::r8fvspline C pspline_calls::r8fvtricub C pspline_calls::r8fvtricubx C pspline_calls::r8genxpkg C pspline_calls::r8gridbicub C pspline_calls::r8gridherm1 C pspline_calls::r8gridherm2 C pspline_calls::r8gridherm3 C pspline_calls::r8gridintrp2d C pspline_calls::r8gridintrp3d C pspline_calls::r8gridpc1 C pspline_calls::r8gridpc2 C pspline_calls::r8gridpc3 C pspline_calls::r8gridspline C pspline_calls::r8gridtricub C pspline_calls::r8herm1ev C pspline_calls::r8herm1fcn C pspline_calls::r8herm1x C pspline_calls::r8herm2ev C pspline_calls::r8herm2fcn C pspline_calls::r8herm2fcnx C pspline_calls::r8herm2xy C pspline_calls::r8herm3ev C pspline_calls::r8herm3fcn C pspline_calls::r8herm3fcnx C pspline_calls::r8herm3xyz C pspline_calls::r8mkbicon C pspline_calls::r8mkbicop C pspline_calls::r8mkbicub C pspline_calls::r8mkbicubw C pspline_calls::r8mkherm1 C pspline_calls::r8mkherm2 C pspline_calls::r8mkherm3 C pspline_calls::r8mkintrp2d C pspline_calls::r8mkintrp3d C pspline_calls::r8mkspl2p C pspline_calls::r8mkspl2pb C pspline_calls::r8mkspl2z C pspline_calls::r8mkspl2zb C pspline_calls::r8mkspl3pb C pspline_calls::r8mkspl3zb C pspline_calls::r8mkspline C pspline_calls::r8mktricon C pspline_calls::r8mktricop C pspline_calls::r8mktricub C pspline_calls::r8mktricubw C pspline_calls::r8nspline C pspline_calls::r8pc1ev C pspline_calls::r8pc1fcn C pspline_calls::r8pc2ev C pspline_calls::r8pc2fcn C pspline_calls::r8pc2fcnx C pspline_calls::r8pc3ev C pspline_calls::r8pc3fcn C pspline_calls::r8pc3fcnx C pspline_calls::r8pspline C pspline_calls::r8seval C pspline_calls::r8seval2 C pspline_calls::r8seval3 C pspline_calls::r8speval C pspline_calls::r8spgrid C pspline_calls::r8splaan C pspline_calls::r8splbrk C pspline_calls::r8spleen C pspline_calls::r8splinck C pspline_calls::r8spline C pspline_calls::r8spvec C pspline_calls::r8tcsp23 C pspline_calls::r8tcspcorr C pspline_calls::r8tcspeval C pspline_calls::r8tcspevfn C pspline_calls::r8tcspevxyz C pspline_calls::r8tcspgrid C pspline_calls::r8tcspline C pspline_calls::r8tcspvec C pspline_calls::r8tpsplinb C pspline_calls::r8tpspline C pspline_calls::r8util_bcherm1 C pspline_calls::r8util_bcherm2 C pspline_calls::r8util_bcherm3 C pspline_calls::r8v_spline C pspline_calls::r8vecbicub C pspline_calls::r8vecherm1 C pspline_calls::r8vecherm2 C pspline_calls::r8vecherm3 C pspline_calls::r8vecintrp2d C pspline_calls::r8vecintrp3d C pspline_calls::r8vecpc1 C pspline_calls::r8vecpc2 C pspline_calls::r8vecpc3 C pspline_calls::r8vecspline C pspline_calls::r8vectricub C pspline_calls::r8xlookup C pspline_calls::r8zonfind ► C radial_quantity A radial quantity C full_grid A full grid quantity C half_grid A half grid quantity C reconstruction::reconstruction_class Base class containing all the data needed to reconstruct a model C vmec_equilibrium::runvmec Forward declare the interface for runvmec C integration_path_context::search_function Interface for the search function ► C integration_path_context::search_path_context_class Search context object interface C ece::ece_context Structure to hold all memory needed to be sent to the callback function C integration_path::test_search_context A type for the test cases C utilities::set_bndy_fouier_m0 Interface to set the fouier conditions on a quantity for either scalar set_bndy_fouier_m0 or vector set_bndy_fouier_m0_vec quantities C pspline_calls::seval C pspline_calls::seval2 C pspline_calls::seval3 C siesta_context::siesta_context_class Base class representing a siesta_context . This contains a copy of every variable that is needed to define the SIESTA state C siesta_file::siesta_file_class Base class representing a siesta output C siesta_fourier< GRID_CLASS, PARITY > A cosine parity vmec quantity C siesta_fourier< full_grid, cosine > C siesta_fourier< full_grid, sine > C siesta_fourier< half_grid, cosine > C siesta_fourier< half_grid, sine > C siesta_grid< GRID_CLASS > A radial siesta quantity C siesta_grid< full_grid > C siesta_quantities Siesta quantities C siesta_run::siesta_run_class Interface for the siesta_run constructor ► C signal::signal_class Base class representing a signal C combination::combination_class Base class representing a combination signal C ece::ece_class Base class representing an ECE signal C extcurz::extcurz_class Base class representing a external Z currents enclosed by an inegration loop ► C intpol::intpol_class Base class representing a interferometer signal C intpol::intpol_pol_class Base class representing a polarimetry signal ► C limiter::limiter_class Base class representing a limiter signal C limiter_grid::limiter_grid_class Base class representing a limiter signal C limiter_iso_t::limiter_iso_class Base class representing a limiter_iso function C magnetic::magnetic_class Base class representing a magnetic signal C mse::mse_class Base class representing a mse signal C prior_gaussian::prior_gaussian_class Base class representing a prior_guassian signal ► C sxrem::sxrem_class Base class representing a soft x-ray signal C sxrem::sxrem_emiss_class Base class representing a soft x-ray emissivity signal C sxrem::sxrem_ti_class Base class representing a soft x-ray ti signal C sxrem_ratio::sxrem_ratio_class Base class representing a sxrem_ratio signal ► C thomson::thomson_class Base class representing a thomson scattering signal C thomson::thomson_ne_class Base class representing a thomson scattering te signal C thomson::thomson_p_class Base class representing a thomson scattering te signal C thomson::thomson_te_class Base class representing a thomson scattering te signal C signal::signal_construct Interface for the construction of signal_class types using signal_construct_new or signal_construct_diagnostic_netcdf C signal_dot::signal_dot_file Base class representing a diagnostic dot file. This is an opaqe class C signal::signal_pointer Pointer to a signal object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly C v3post_rfun::signals C blocktridiagonalsolver::solutionelement Solution of selected rows of interest to this rank C blocktridiagonalsolver_bst::solutionelement Solution of selected rows of interest to this rank C pspline_calls::speval C pspline_calls::spgrid C pspline_calls::splaan C pspline_calls::splbrk C pspline_calls::spleen C pspline_calls::splinck C pspline_calls::spline C pspline_calls::spvec C surface_commandline_parser::surface_commandline_parser_class Base class containing a parsed surface_commandline C surface_context::surface_context_class Base class representing a surface context. This contains all memory needed to operate surface C sxrch_t::sxrch_desc C system_mod::system C pspline_calls::tcsp23 C pspline_calls::tcspcorr C pspline_calls::tcspeval C pspline_calls::tcspevfn C pspline_calls::tcspevxyz C pspline_calls::tcspgrid C pspline_calls::tcspline C pspline_calls::tcspvec C thscte_t::thscte_desc C blocktridiagonalsolver::timecount Statistics (timing, etc.) C blocktridiagonalsolver_bst::timecount Statistics (timing, etc.) C utilities::to_full_mesh Interface to convert between half and full mesh using either to_full_mesh2 or to_full_mesh3 C utilities::to_half_mesh Interface to convert between full and half mesh using either to_half_mesh or to_half_mesh_p C pspline_calls::tpsplinb C pspline_calls::tpspline C unprimed_grid::unprimed_grid_class Base class representing a unprimed grid. This is grid the volume integral will be summed over C pspline_calls::util_bcherm1 C pspline_calls::util_bcherm2 C pspline_calls::util_bcherm3 C v3fit_context::v3fit_context_class Base class representing a v3fit context. This contains all memory needed to operate v3fit C v3rfun_context::v3rfun_context_class Base class representing a v3rfun context. This contains all memory needed to operate v3rfun C pspline_calls::v_spline C pspline_calls::vecbicub C pspline_calls::vecherm1 C pspline_calls::vecherm2 C pspline_calls::vecherm3 C pspline_calls::vecin2d_argchk C pspline_calls::vecin3d_argchk C pspline_calls::vecintrp2d C pspline_calls::vecintrp3d C pspline_calls::vecpc1 C pspline_calls::vecpc2 C pspline_calls::vecpc3 C pspline_calls::vecspline C vector3d A vector C pspline_calls::vectricub C integration_path::vertex A single point in space defined by an z, y, z coordinate. A vertex is structured as a singly linked list C vertex A vertex C vertex_list::vertex C vmec_context::vmec_context_class Base class representing a vmec_context . This contains a copy of every variable that is needed to define the VMEC state C vmec_file::vmec_file_class Base class representing a vmec output C vmec_fourier< GRID_CLASS, PARITY > A cosine parity vmec quantity C vmec_fourier< full_grid, cosine > C vmec_fourier< full_grid, sine > C vmec_fourier< half_grid, cosine > C vmec_fourier< half_grid, sine > C vmec_grid< GRID_CLASS > A radial vmec quantity C vmec_grid< full_grid > C vmec_equilibrium::vmec_magnetic_cache Object to cache data needed to compute magnetic signals C vmec_quantities Vmec quantities C write_array_generic::write_array C vacfield_mod::write_invac C pspline_calls::xlookup C pspline_calls::zonfind C gradient_descent::check Interface for checking the results of the unit tests C integration_path::check Interface for checking the results of the unit tests C read_response::clresfun C read_response_nompi::clresfun C commandline_parser A radial quantity C vmec_test::commandline_parser A radial quantity C commandline_parser::commandline_parser_class Base class containing a parsed commandline C compression::compression_class Base class containing buffers for compressed and uncompressed data C compression::compression_construct Interface for the construction of compression_class types using compression_construct_new or compression_construct_netcdf C compression::compression_pointer Pointer to a compression object. Used for creating arrays of compression pointers. This is needed because fortran does not allow arrays of pointers directly C parallel_vmec_module::copylastntype C pspline_calls::cspeval C pspline_calls::cspevfn C pspline_calls::cspevx C pspline_calls::cspline C pspline_calls::cubsplb C utilities::curl_htof Interface to take the curl on a half mesh quantity and return a full mesh using either curl_htof or curl_htof_targ C cyl_flux::cyl_flux_context Structure to house needed internal state for cyl2flux C diagnostic_cdf::diagnostic_cdf_define C diagnostic_cdf::diagnostic_cdf_read C diagnostic_cdf::diagnostic_cdf_write C diagnostic_t::diagnostic_construct C diagnostic_t::diagnostic_desc C diagnostic_t::diagnostic_destroy C diagnostic_dot::diagnostic_dot_coil A single coil. A coil set is structured as a singly linked list C diagnostic_t::diagnostic_write C pspline_calls::dnherm1 C pspline_calls::dnherm2 C pspline_calls::dnherm3 C emission::emission_class Base class representing the soft x-ray emission function C emission::emission_construct ► C equilibrium::equilibrium_class Base class representing a equilibrium C vacuum_equilibrium::vacuum_class Base class representing a vacuum_equilibrium ► C vmec_equilibrium::vmec_class Base class representing a vmec_equilibrium C siesta_equilibrium::siesta_class Base class representing a siesta_equilibrium C equilibrium::equilibrium_construct Interface for the construction of equilibrium_class types using equilibrium_construct_vmec, equilibrium_construct_vacuum or equilibrium_construct_siesta C pspline_calls::evbicub C pspline_calls::evintrp2d C pspline_calls::evintrp3d C pspline_calls::evspline C pspline_calls::evtricub C extcurz_t::extcurz_desc C ezspline::ezhybrid_init C ezspline::ezlinear_init C ezspline_type::ezspline1_r4 C ezspline_type::ezspline1_r8 C ezspline_type::ezspline2_r4 C ezspline_type::ezspline2_r8 C ezspline_type::ezspline3_r4 C ezspline_type::ezspline3_r8 C ezspline::ezspline_2netcdf C ezspline_obj::ezspline_allocated C ezspline::ezspline_derivative C ezspline::ezspline_free C ezspline::ezspline_gradient C ezspline::ezspline_init C ezspline::ezspline_interp C ezspline::ezspline_isgridregular C ezspline::ezspline_isindomain C ezspline::ezspline_load C ezspline::ezspline_modulo C ezspline_obj::ezspline_preinit C ezspline::ezspline_save C ezspline::ezspline_setup C pspline_calls::f2test C pspline_calls::f3test C fftpack::fact C fftpack::fftfax C fftpack::fftrig C fourier::fourier_class Base class containing fourier memory C pspline_calls::fvbicub C pspline_calls::fvbicubx C pspline_calls::fvintrp2d C pspline_calls::fvintrp3d C pspline_calls::fvspline C pspline_calls::fvtricub C pspline_calls::fvtricubx C hessian::gather_array C guassian_process::gaussp_class Base class representing a gaussian process C guassian_process::gaussp_class_pointer Pointer to a gaussian process object. Used for creating arrays of gaussian process pointers. This is needed because fortran does not allow arrays of pointers directly C pspline_calls::genxpkg C vmec_utils::getbcyl C system_mod::getenv C vmec_utils::getjcyl C system_mod::getpid C gmres_lib::gmres_info ► C gradient_descent::gradient_descent_class Base class containing the parameters for the gradient_descent C gradient_descent::gradient_descent_test_class Base class containing the parameters for the gradient_descent C utilities::gradienthalf Interface to take the gradianet from full to half mesh using either GradientHalf or GradientHalf_p C pspline_calls::gridbicub C pspline_calls::gridherm1 C pspline_calls::gridherm2 C pspline_calls::gridherm3 C pspline_calls::gridintrp2d C pspline_calls::gridintrp3d C pspline_calls::gridpc1 C pspline_calls::gridpc2 C pspline_calls::gridpc3 C pspline_calls::gridspline C pspline_calls::gridtricub C pspline_calls::herm1ev C pspline_calls::herm1fcn C pspline_calls::herm1x C pspline_calls::herm2ev C pspline_calls::herm2fcn C pspline_calls::herm2fcnx C pspline_calls::herm2xy C pspline_calls::herm3ev C pspline_calls::herm3fcn C pspline_calls::herm3fcnx C pspline_calls::herm3xyz C pspline_calls::ibc_ck C integration_path_context::integration_function Interface for the integration function ► C integration_path::integration_path_class Base class containing the parameters of the integration method to use ► C integration_path::integration_path_gleg_class Subclass to use Gauss Legendre Quadrature C integration_path::integration_path_hp_glep_class Subclass to use hp approch ► C integration_path_context::integration_path_context_class Integration context object interface C integration_path::test_context A type for the test cases C intpol::intpol_gp_int_context_i Structure to hold all memory needed to be sent to the guassian process callback function of a point C intpol::intpol_gp_int_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C intpol::intpol_gp_int_context_x Structure to hold all memory needed to be sent to the guassian process callback function for position C intpol::intpol_gp_pol_context_i Structure to hold all memory needed to be sent to the guassian process callback function of a point C intpol::intpol_gp_pol_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C intpol::intpol_gp_pol_context_x Structure to hold all memory needed to be sent to the guassian process callback function for position C intpol::intpol_int_context Struture to hole all memort needed to be sent to the integration callback function C intpol::intpol_pol_context Struture to hole all memort needed to be sent to the integration callback function ► C sxrem::sxrem_context Structure to hold all memory needed to be sent to the callback function ► C sxrem::sxrem_gp_context_i Structure to hold all memory needed to be sent to the guassian process callback function for point C sxrem::sxrem_gp_ti_context_i Structure to hold all memory needed to be sent to the guassian process callback function for point ► C sxrem::sxrem_gp_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem::sxrem_gp_ti_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal ► C sxrem::sxrem_gp_context_x Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem::sxrem_gp_ti_context_x Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem::sxrem_ti_context Structure to hold all memory needed to be sent to the callback function C ipch_t::ipch_desc C blocktridiagonalsolver::levelelement Data associated with each row at each level C blocktridiagonalsolver_bst::levelelement Data associated with each row at each level C liprec::li_gbfa C liprec::li_gbsl C liprec::li_gefa C liprec::li_gesl C m_grid::m_grid_class Base class representing a m grid. This is grid contains information about the vacuum fields C vertex_list::magfield C magnetic_response::magnetic_response_class Base class representing a magnetic signal response function C magnetic_response::magnetic_response_construct Interface for the construction of magnetic_response_class types using magnetic_response_construct_new , & magnetic_response_construct_point or & magnetic_response_construct_netcdf C blocktridiagonalsolver::mastertoslavemapping Master-to-slave mapping C blocktridiagonalsolver_bst::mastertoslavemapping Master-to-slave mapping C mddc_cdf::mddc_cdf_define C mddc_cdf::mddc_cdf_read C mddc_cdf::mddc_cdf_write C mddc_t::mddc_construct C mddc_t::mddc_desc C mddc_t::mddc_destroy C mddc_t::mddc_mrf C mddc_t::mddc_write C pspline_calls::mkbicon C pspline_calls::mkbicop C pspline_calls::mkbicub C pspline_calls::mkbicubw C pspline_calls::mkherm1 C pspline_calls::mkherm2 C pspline_calls::mkherm3 C pspline_calls::mkintrp2d C pspline_calls::mkintrp3d C pspline_calls::mkspl2p C pspline_calls::mkspl2pb C pspline_calls::mkspl2z C pspline_calls::mkspl2zb C pspline_calls::mkspl3pb C pspline_calls::mkspl3zb C pspline_calls::mkspline C pspline_calls::mktricon C pspline_calls::mktricop C pspline_calls::mktricub C pspline_calls::mktricubw C model::model_class Base class representing a model C vmec_utils::mse_pitch C netcdf_inc::nf_close Interface to open a file C netcdf_inc::nf_create Interface to open a file C netcdf_inc::nf_def_dim Interface to define a dimension C netcdf_inc::nf_enddef Interface to inquire a dimension id C netcdf_inc::nf_get_var_double Interface for reading double variables C netcdf_inc::nf_get_var_int Interface for reading integer variables C netcdf_inc::nf_get_var_real Interface for reading real variables. Note double 2D array used by complex real array values C netcdf_inc::nf_inq_dimid Interface to inquire a dimension id C netcdf_inc::nf_inq_varid Interface to inquire a variable id C netcdf_inc::nf_open Interface to open a file C netcdf_inc::nf_put_var_double Interface for writing double variables C netcdf_inc::nf_put_var_int Interface for writing integer variables C netcdf_inc::nf_put_var_real Interface for writing real variables. Note double 2D array used by complex real array values C netcdf_inc::nf_put_vara_double Interface for reading double variables. Note double 2D array used by complex double array values C netcdf_inc::nf_put_vara_int Interface for writing integer variables C netcdf_inc::nf_put_vara_real Interface for reading real variables. Note double 2D array used by complex real array values C netcdf_inc::nf_strerror Interface to inquire a dimension id C pspline_calls::nspline C v3fit_params::param_class Base class representing a reconstructed parameter. An upper and lower bound may be set for the parameter value C v3fit_params::param_construct Interface for the construction of param_class types using param_construct_basic or param_construct_recon C v3fit_params::param_locking_class Class to hold variables needed when a parameter is a locking parameter. The locking parameter coefficents are stored in the correlation array of the parent type C v3fit_params::param_pointer Pointer to a parameter object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly C v3fit_params::param_recon_class Class to hold variables needed when a parameter is a reconstruction parameter C v3fit_params::param_write_step_data Interface for the writting of param_class data to the result file using param_write_step_data_1 or param_write_step_data_2 ► C parity Parity function interface C cosine Cosine Parity function interface C sine Sine Parity function interface C integration_path::path_construct Construction interface using path_construct_vertex C integration_path::path_destruct Destruct interface using path_destruct_vertex C vertex_list::pbfield C blocktridiagonalsolver::pblaslevelparameters Level-specific PBLAS information C blocktridiagonalsolver_bst::pblaslevelparameters Level-specific PBLAS information C blocktridiagonalsolver::pblasstats C blocktridiagonalsolver_bst::pblasstats C blocktridiagonalsolver::pblastemparray C blocktridiagonalsolver_bst::pblastemparray C pspline_calls::pc1ev C pspline_calls::pc1fcn C pspline_calls::pc2ev C pspline_calls::pc2fcn C pspline_calls::pc2fcnx C pspline_calls::pc3ev C pspline_calls::pc3fcn C pspline_calls::pc3fcnx C vertex_list::point C pprofile_t::pprofile_class Base class representing a parameterized profile C pprofile_t::pprofile_pointer Pointer to a pprofile object. Used for creating arrays of pprofile pointers. This is needed because fortran does not allow arrays of pointers directly C read_response::prfun C read_response_nompi::prfun C primed_grid::primed_grid_class Base class representing a primed grid. This is grid the volume integral will be summed over C profiler::profiler_bucket Full table of profiled functions C pspline_calls::pspline C system_mod::putenv C vertex_list::pvertex C system_mod::pxffork C system_mod::pxfwait C pspline_calls::r8akherm0 C pspline_calls::r8akherm1 C pspline_calls::r8akherm1p C pspline_calls::r8akherm2 C pspline_calls::r8akherm2p C pspline_calls::r8akherm3 C pspline_calls::r8akherm3p C pspline_calls::r8bcspeval C pspline_calls::r8bcspevfn C pspline_calls::r8bcspevxy C pspline_calls::r8bcspgrid C pspline_calls::r8bcspline C pspline_calls::r8bcspvec C pspline_calls::r8bpsplinb C pspline_calls::r8bpspline C pspline_calls::r8cspeval C pspline_calls::r8cspevfn C pspline_calls::r8cspevx C pspline_calls::r8cspline C pspline_calls::r8cubsplb C pspline_calls::r8dnherm1 C pspline_calls::r8dnherm2 C pspline_calls::r8dnherm3 C pspline_calls::r8evbicub C pspline_calls::r8evintrp2d C pspline_calls::r8evintrp3d C pspline_calls::r8evspline C pspline_calls::r8evtricub C pspline_calls::r8f2test C pspline_calls::r8f3test C pspline_calls::r8fvbicub C pspline_calls::r8fvbicubx C pspline_calls::r8fvintrp2d C pspline_calls::r8fvintrp3d C pspline_calls::r8fvspline C pspline_calls::r8fvtricub C pspline_calls::r8fvtricubx C pspline_calls::r8genxpkg C pspline_calls::r8gridbicub C pspline_calls::r8gridherm1 C pspline_calls::r8gridherm2 C pspline_calls::r8gridherm3 C pspline_calls::r8gridintrp2d C pspline_calls::r8gridintrp3d C pspline_calls::r8gridpc1 C pspline_calls::r8gridpc2 C pspline_calls::r8gridpc3 C pspline_calls::r8gridspline C pspline_calls::r8gridtricub C pspline_calls::r8herm1ev C pspline_calls::r8herm1fcn C pspline_calls::r8herm1x C pspline_calls::r8herm2ev C pspline_calls::r8herm2fcn C pspline_calls::r8herm2fcnx C pspline_calls::r8herm2xy C pspline_calls::r8herm3ev C pspline_calls::r8herm3fcn C pspline_calls::r8herm3fcnx C pspline_calls::r8herm3xyz C pspline_calls::r8mkbicon C pspline_calls::r8mkbicop C pspline_calls::r8mkbicub C pspline_calls::r8mkbicubw C pspline_calls::r8mkherm1 C pspline_calls::r8mkherm2 C pspline_calls::r8mkherm3 C pspline_calls::r8mkintrp2d C pspline_calls::r8mkintrp3d C pspline_calls::r8mkspl2p C pspline_calls::r8mkspl2pb C pspline_calls::r8mkspl2z C pspline_calls::r8mkspl2zb C pspline_calls::r8mkspl3pb C pspline_calls::r8mkspl3zb C pspline_calls::r8mkspline C pspline_calls::r8mktricon C pspline_calls::r8mktricop C pspline_calls::r8mktricub C pspline_calls::r8mktricubw C pspline_calls::r8nspline C pspline_calls::r8pc1ev C pspline_calls::r8pc1fcn C pspline_calls::r8pc2ev C pspline_calls::r8pc2fcn C pspline_calls::r8pc2fcnx C pspline_calls::r8pc3ev C pspline_calls::r8pc3fcn C pspline_calls::r8pc3fcnx C pspline_calls::r8pspline C pspline_calls::r8seval C pspline_calls::r8seval2 C pspline_calls::r8seval3 C pspline_calls::r8speval C pspline_calls::r8spgrid C pspline_calls::r8splaan C pspline_calls::r8splbrk C pspline_calls::r8spleen C pspline_calls::r8splinck C pspline_calls::r8spline C pspline_calls::r8spvec C pspline_calls::r8tcsp23 C pspline_calls::r8tcspcorr C pspline_calls::r8tcspeval C pspline_calls::r8tcspevfn C pspline_calls::r8tcspevxyz C pspline_calls::r8tcspgrid C pspline_calls::r8tcspline C pspline_calls::r8tcspvec C pspline_calls::r8tpsplinb C pspline_calls::r8tpspline C pspline_calls::r8util_bcherm1 C pspline_calls::r8util_bcherm2 C pspline_calls::r8util_bcherm3 C pspline_calls::r8v_spline C pspline_calls::r8vecbicub C pspline_calls::r8vecherm1 C pspline_calls::r8vecherm2 C pspline_calls::r8vecherm3 C pspline_calls::r8vecintrp2d C pspline_calls::r8vecintrp3d C pspline_calls::r8vecpc1 C pspline_calls::r8vecpc2 C pspline_calls::r8vecpc3 C pspline_calls::r8vecspline C pspline_calls::r8vectricub C pspline_calls::r8xlookup C pspline_calls::r8zonfind ► C radial_quantity A radial quantity C full_grid A full grid quantity C half_grid A half grid quantity C reconstruction::reconstruction_class Base class containing all the data needed to reconstruct a model C vmec_equilibrium::runvmec Forward declare the interface for runvmec C integration_path_context::search_function Interface for the search function ► C integration_path_context::search_path_context_class Search context object interface C ece::ece_context Structure to hold all memory needed to be sent to the callback function C integration_path::test_search_context A type for the test cases C utilities::set_bndy_fouier_m0 Interface to set the fouier conditions on a quantity for either scalar set_bndy_fouier_m0 or vector set_bndy_fouier_m0_vec quantities C pspline_calls::seval C pspline_calls::seval2 C pspline_calls::seval3 C siesta_context::siesta_context_class Base class representing a siesta_context . This contains a copy of every variable that is needed to define the SIESTA state C siesta_file::siesta_file_class Base class representing a siesta output C siesta_fourier< GRID_CLASS, PARITY > A cosine parity vmec quantity C siesta_fourier< full_grid, cosine > C siesta_fourier< full_grid, sine > C siesta_fourier< half_grid, cosine > C siesta_fourier< half_grid, sine > C siesta_grid< GRID_CLASS > A radial siesta quantity C siesta_grid< full_grid > C siesta_quantities Siesta quantities C siesta_run::siesta_run_class Interface for the siesta_run constructor ► C signal::signal_class Base class representing a signal C combination::combination_class Base class representing a combination signal C ece::ece_class Base class representing an ECE signal C extcurz::extcurz_class Base class representing a external Z currents enclosed by an inegration loop ► C intpol::intpol_class Base class representing a interferometer signal C intpol::intpol_pol_class Base class representing a polarimetry signal ► C limiter::limiter_class Base class representing a limiter signal C limiter_grid::limiter_grid_class Base class representing a limiter signal C limiter_iso_t::limiter_iso_class Base class representing a limiter_iso function C magnetic::magnetic_class Base class representing a magnetic signal C mse::mse_class Base class representing a mse signal C prior_gaussian::prior_gaussian_class Base class representing a prior_guassian signal ► C sxrem::sxrem_class Base class representing a soft x-ray signal C sxrem::sxrem_emiss_class Base class representing a soft x-ray emissivity signal C sxrem::sxrem_ti_class Base class representing a soft x-ray ti signal C sxrem_ratio::sxrem_ratio_class Base class representing a sxrem_ratio signal ► C thomson::thomson_class Base class representing a thomson scattering signal C thomson::thomson_ne_class Base class representing a thomson scattering te signal C thomson::thomson_p_class Base class representing a thomson scattering te signal C thomson::thomson_te_class Base class representing a thomson scattering te signal C signal::signal_construct Interface for the construction of signal_class types using signal_construct_new or signal_construct_diagnostic_netcdf C signal_dot::signal_dot_file Base class representing a diagnostic dot file. This is an opaqe class C signal::signal_pointer Pointer to a signal object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly C v3post_rfun::signals C blocktridiagonalsolver::solutionelement Solution of selected rows of interest to this rank C blocktridiagonalsolver_bst::solutionelement Solution of selected rows of interest to this rank C pspline_calls::speval C pspline_calls::spgrid C pspline_calls::splaan C pspline_calls::splbrk C pspline_calls::spleen C pspline_calls::splinck C pspline_calls::spline C pspline_calls::spvec C surface_commandline_parser::surface_commandline_parser_class Base class containing a parsed surface_commandline C surface_context::surface_context_class Base class representing a surface context. This contains all memory needed to operate surface C sxrch_t::sxrch_desc C system_mod::system C pspline_calls::tcsp23 C pspline_calls::tcspcorr C pspline_calls::tcspeval C pspline_calls::tcspevfn C pspline_calls::tcspevxyz C pspline_calls::tcspgrid C pspline_calls::tcspline C pspline_calls::tcspvec C thscte_t::thscte_desc C blocktridiagonalsolver::timecount Statistics (timing, etc.) C blocktridiagonalsolver_bst::timecount Statistics (timing, etc.) C utilities::to_full_mesh Interface to convert between half and full mesh using either to_full_mesh2 or to_full_mesh3 C utilities::to_half_mesh Interface to convert between full and half mesh using either to_half_mesh or to_half_mesh_p C pspline_calls::tpsplinb C pspline_calls::tpspline C unprimed_grid::unprimed_grid_class Base class representing a unprimed grid. This is grid the volume integral will be summed over C pspline_calls::util_bcherm1 C pspline_calls::util_bcherm2 C pspline_calls::util_bcherm3 C v3fit_context::v3fit_context_class Base class representing a v3fit context. This contains all memory needed to operate v3fit C v3rfun_context::v3rfun_context_class Base class representing a v3rfun context. This contains all memory needed to operate v3rfun C pspline_calls::v_spline C pspline_calls::vecbicub C pspline_calls::vecherm1 C pspline_calls::vecherm2 C pspline_calls::vecherm3 C pspline_calls::vecin2d_argchk C pspline_calls::vecin3d_argchk C pspline_calls::vecintrp2d C pspline_calls::vecintrp3d C pspline_calls::vecpc1 C pspline_calls::vecpc2 C pspline_calls::vecpc3 C pspline_calls::vecspline C vector3d A vector C pspline_calls::vectricub C integration_path::vertex A single point in space defined by an z, y, z coordinate. A vertex is structured as a singly linked list C vertex A vertex C vertex_list::vertex C vmec_context::vmec_context_class Base class representing a vmec_context . This contains a copy of every variable that is needed to define the VMEC state C vmec_file::vmec_file_class Base class representing a vmec output C vmec_fourier< GRID_CLASS, PARITY > A cosine parity vmec quantity C vmec_fourier< full_grid, cosine > C vmec_fourier< full_grid, sine > C vmec_fourier< half_grid, cosine > C vmec_fourier< half_grid, sine > C vmec_grid< GRID_CLASS > A radial vmec quantity C vmec_grid< full_grid > C vmec_equilibrium::vmec_magnetic_cache Object to cache data needed to compute magnetic signals C vmec_quantities Vmec quantities C write_array_generic::write_array C vacfield_mod::write_invac C pspline_calls::xlookup C pspline_calls::zonfind Stellarator-Tools: Member List
+
+
+
+
+
+
+ Stellarator-Tools
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for gradient_descent::check , including all inherited members.
+
+
Stellarator-Tools: gradient_descent::check Interface Reference
+
+
+
+
+
+
+ Stellarator-Tools
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Interface for checking the results of the unit tests.
+ More...
+
+logical function check_log (expected, received, testNum, name) Check a logical value. More... logical function check_real (expected, received, testNum, name) Check a real value. More...
+
+
Interface for checking the results of the unit tests.
+
+
+
◆
+
+
+
+
+
+ logical function gradient_descent::check::check_log
+ (
+ logical, intent(in)
+ expected ,
+
+ logical, intent(in)
+ received ,
+
+ integer, intent(in)
+ testNum ,
+
+ character (len=*), intent(in)
+ name
+
+ )
+
+
+
+
+
Check a logical value.
+
Checks that the expected value matches the recieved. Otherwise report an error.
+
Parameters
+
+ [in] expected The known value. [in] received The known test value. [in] testNum The number of the test. [in] name The name of the test.
+
+
+
Returns True if the check passes and false otherwise.
+
+
+
+
+
◆
+
+
+
+
+
+ logical function gradient_descent::check::check_real
+ (
+ real(rprec), intent(in)
+ expected ,
+
+ real(rprec), intent(in)
+ received ,
+
+ integer, intent(in)
+ testNum ,
+
+ character (len=*), intent(in)
+ name
+
+ )
+
+
+
+
+
Check a real value.
+
Checks that the expected value matches the recieved. Otherwise report an error.
+
Parameters
+
+ [in] expected The known value. [in] received The known test value. [in] testNum The number of the test. [in] name The name of the test.
+
+
+
Returns True if the check passes and false otherwise.
+
+
+
+
The documentation for this interface was generated from the following file:
+
+
Stellarator-Tools: gradient_descent Module Reference
+
+
+
+
+
+
+ Stellarator-Tools
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Module is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path.
+More...
+
+
+
Module is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path.
+
+
+
◆
+
+
+
+
+
+ subroutine gradient_descent::gradient_descent_chi2
+ (
+ class (gradient_descent_class ), intent(in)
+ this ,
+
+ real (rprec), dimension(:), intent(out)
+ chi2
+
+ )
+
+
+
+
+
Compute the χ^2 value and the gradients.
+
This method should not be called directly and needs to be overloaded in a subclass.
+
Parameters
+
+ [in] this A gradient_descent_context instance. [out] chi2 The χ^2 value and the gradients.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ subroutine gradient_descent::gradient_descent_destruct
+ (
+ type (gradient_descent_class ), intent(inout)
+ this )
+
+
+
+
+
+
◆
+
+
+
+
+
+ real (rprec) function gradient_descent::gradient_descent_minimize
+ (
+ class (gradient_descent_class ), intent(in)
+ this )
+
+
+
+
+
Gradient descent to minimize the χ^2 function.
+
Parameters
+
+ [in,out] this A gradient_descent_context instance.
+
+
+
Returns The χ^2 residule.
+
+
+
+
+
◆
+
+
+
+
+
+ logical function gradient_descent::gradient_descent_test
+
+
+
+
+
Gradient descent unit test function.
+
This runs the associated unit tests and returns the result.
+
Returns True if the tests pass and false otherwise.
+
+
+
+
+
◆
+
+
+
+
+
+ subroutine gradient_descent::gradient_descent_test_chi2
+ (
+ class (gradient_descent_test_class ), intent(in)
+ this ,
+
+ real (rprec), dimension(:), intent(out)
+ chi2
+
+ )
+
+
+
+
+
Compute the χ^2 value and the gradients.
+
This method should not be called directly and needs to be overloaded in a subclass.
+
Parameters
+
+ [in] this A gradient_descent_context instance. [out] chi2 The χ^2 value and the gradients.
+
+
+
+
+
+
+
◆
+
+
+
+
gr2rank()
: blocktridiagonalsolver
+gradient_descent_chi2()
+: gradient_descent
+
+gradient_descent_destruct()
+: gradient_descent
+
+gradient_descent_minimize()
+: gradient_descent
+
+gradient_descent_test()
+: gradient_descent
+
+gradient_descent_test_chi2()
+: gradient_descent
+
+gradient_descent_test_construct()
+: gradient_descent
+
gradientfull()
: utilities
diff --git a/docs/namespacemembers_g.html b/docs/namespacemembers_g.html
index acf1368..60e9613 100644
--- a/docs/namespacemembers_g.html
+++ b/docs/namespacemembers_g.html
@@ -196,6 +196,24 @@
gr2rank()
: blocktridiagonalsolver
+gradient_descent_chi2()
+: gradient_descent
+
+gradient_descent_destruct()
+: gradient_descent
+
+gradient_descent_minimize()
+: gradient_descent
+
+gradient_descent_test()
+: gradient_descent
+
+gradient_descent_test_chi2()
+: gradient_descent
+
+gradient_descent_test_construct()
+: gradient_descent
+
gradientfull()
: utilities
diff --git a/docs/namespaces.html b/docs/namespaces.html
index 9aa55ea..e5cca66 100644
--- a/docs/namespaces.html
+++ b/docs/namespaces.html
@@ -257,550 +257,554 @@
► N gmres_lib C gmres_info N gmres_mod ► N guassian_process Defines the base class of the type guassian_process_class. The guassian_process contains code to compuet guassian process profiles C gaussp_class Base class representing a gaussian process C gaussp_class_pointer Pointer to a gaussian process object. Used for creating arrays of gaussian process pointers. This is needed because fortran does not allow arrays of pointers directly ► N hessian C gather_array N init_geometry ► N integration_path Module is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path C integration_path_class Base class containing the parameters of the integration method to use C integration_path_gleg_class Subclass to use Gauss Legendre Quadrature C integration_path_hp_glep_class Subclass to use hp approch C vertex A single point in space defined by an z, y, z coordinate. A vertex is structured as a singly linked list C test_context A type for the test cases C test_search_context A type for the test cases C path_construct Construction interface using path_construct_vertex C path_destruct Destruct interface using path_destruct_vertex C check Interface for checking the results of the unit tests ► N integration_path_context Module is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path C integration_path_context_class Integration context object interface C search_path_context_class Search context object interface C integration_function Interface for the integration function C search_function Interface for the search function ► N intpol Implements interferometry/polarimetry diagnostic. Defines the base class of the type intpol_class C intpol_class Base class representing a interferometer signal C intpol_pol_class Base class representing a polarimetry signal C intpol_int_context Struture to hole all memort needed to be sent to the integration callback function C intpol_pol_context Struture to hole all memort needed to be sent to the integration callback function C intpol_gp_int_context_i Structure to hold all memory needed to be sent to the guassian process callback function of a point C intpol_gp_pol_context_i Structure to hold all memory needed to be sent to the guassian process callback function of a point C intpol_gp_int_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C intpol_gp_pol_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C intpol_gp_int_context_x Structure to hold all memory needed to be sent to the guassian process callback function for position C intpol_gp_pol_context_x Structure to hold all memory needed to be sent to the guassian process callback function for position N ipch_dot Module for opening and reading a 'ipch.' file. The file format for these files are documented in Inteferometry/Polarimetry Diagnostic Dot File ► N ipch_t C ipch_desc N island_params This file contains fix parameters related to the computational grids ► N limiter Defines the base class of the type limiter_class C limiter_class Base class representing a limiter signal ► N limiter_grid Defines the base class of the type limiter_grid_class C limiter_grid_class Base class representing a limiter signal ► N limiter_iso_t Defines the base class of the type limiter_iso C limiter_iso_class Base class representing a limiter_iso function N line_segment Module is part of the LIBSTELL. This module contains code to create a profile constructed of line sigments. These line segments are assumed to be specified such that xx(i) < xx(i + 1) N linear1_mod ► N liprec C li_gbfa C li_gbsl C li_gefa C li_gesl N lmpar_mod ► N m_grid Defines the base class of the type m_grid_class . This contains the state variables to define the vacuum vector potential C m_grid_class Base class representing a m grid. This is grid contains information about the vacuum fields ► N magnetic Defines the base class of the type magnetic_class C magnetic_class Base class representing a magnetic signal ► N magnetic_response Defines the base class of the type magnetic_response_class C magnetic_response_class Base class representing a magnetic signal response function C magnetic_response_construct Interface for the construction of magnetic_response_class types using magnetic_response_construct_new , & magnetic_response_construct_point or & magnetic_response_construct_netcdf N makegrid_global N math_utilities ► N mddc_cdf C mddc_cdf_define C mddc_cdf_write C mddc_cdf_read ► N mddc_t C mddc_mrf C mddc_desc C assignment(=) C mddc_construct C mddc_destroy C mddc_write N metrics Module for reading in VMEC input and computing metric elements on the SIESTA (sqrt-flux) radial grid. Computes and stores the real-space metric elements, Jacobian based on square root of fluc splined vmec coordinate system N mgrid_mod ► N model Defines the base class of the type model_class . The model contains information not specific to the equilibrium C model_class Base class representing a model N model_state Contains parameters defining the bit positions for flags that mark changes in different parts of the model N modular_coils N mpi_inc Umbrella module avoid multiple inlcudes of the mpif.h header N mpi_params ► N mse Implements motional stark effect diagnostic. Defines the base class of the type mse_class C mse_class Base class representing a mse signal N mse_dot Module for opening and reading a 'mse.' file. The file format for these files are documented in Motional Stark Effect Diagnostic Dot File ► N netcdf_inc Work around to fix some netcdf import problems with the Ezcdf. This module emulates the F77 interface using the F90 interface C nf_open Interface to open a file C nf_create Interface to open a file C nf_close Interface to open a file C nf_enddef Interface to inquire a dimension id C nf_strerror Interface to inquire a dimension id C nf_inq_dimid Interface to inquire a dimension id C nf_def_dim Interface to define a dimension C nf_inq_varid Interface to inquire a variable id C nf_get_var_int Interface for reading integer variables C nf_put_var_int Interface for writing integer variables C nf_put_vara_int Interface for writing integer variables C nf_get_var_real Interface for reading real variables. Note double 2D array used by complex real array values C nf_put_vara_real Interface for reading real variables. Note double 2D array used by complex real array values C nf_put_var_real Interface for writing real variables. Note double 2D array used by complex real array values C nf_get_var_double Interface for reading double variables C nf_put_vara_double Interface for reading double variables. Note double 2D array used by complex double array values C nf_put_var_double Interface for writing double variables N nscalingtools N optim_params N packafile N parallel_include_module ► N parallel_vmec_module C copylastntype N pchelms This file solves the helmholtz equation to set inital fields that match vmec and vacuum currents from the vector potential. Initial vector potential on the edge is supplied by the BMW code N perturbation Subroutines and functionsto apply the helical perturbation to open up islands ► N pprofile_t Defines the base class of the type pprofile_class . This module contains all the code necessary to define parameterized profiles C pprofile_class Base class representing a parameterized profile C pprofile_pointer Pointer to a pprofile object. Used for creating arrays of pprofile pointers. This is needed because fortran does not allow arrays of pointers directly N precon2d ► N primed_grid Defines the base class of the type primed_grid_class . This contains the state variables to define the currents and positions of the volumn integral C primed_grid_class Base class representing a primed grid. This is grid the volume integral will be summed over ► N prior_gaussian Defines the base class of the type prior_gaussian_class . This class implements priors of the type C prior_gaussian_class Base class representing a prior_guassian signal N prof_mod ► N profiler Defines functions for measuring an tabulating performance of function and subroutine calls. These routines are only active when the PROFILE_ON macro is defined C profiler_bucket Full table of profiled functions ► N pspline_calls C akherm1 C akherm1p C akherm0 C akherm2 C akherm2p C akherm3 C akherm3p C bcspeval C bcspevxy C bcspevfn C bcspgrid C bcspline C bcspvec C bpsplinb C bpspline C cspeval C cspevx C cspevfn C cspline C cubsplb C dnherm1 C dnherm2 C dnherm3 C evbicub C fvbicub C fvbicubx C evintrp2d C fvintrp2d C evintrp3d C fvintrp3d C evspline C fvspline C evtricub C fvtricub C fvtricubx C f2test C f3test C genxpkg C gridbicub C gridherm1 C gridherm2 C gridherm3 C gridintrp2d C gridintrp3d C gridpc1 C gridpc2 C gridpc3 C gridspline C gridtricub C herm1ev C herm1x C herm1fcn C herm2ev C herm2xy C herm2fcn C herm2fcnx C herm3ev C herm3xyz C herm3fcn C herm3fcnx C ibc_ck C mkbicub C mkbicubw C mkbicop C mkbicon C mkherm1 C mkherm2 C mkherm3 C mkintrp2d C mkintrp3d C mkspl2pb C mkspl2p C mkspl2zb C mkspl2z C mkspl3pb C mkspl3zb C mkspline C mktricub C mktricubw C mktricop C mktricon C nspline C pc1ev C pc1fcn C pc2ev C pc2fcn C pc2fcnx C pc3ev C pc3fcn C pc3fcnx C pspline C r8akherm1 C r8akherm1p C r8akherm0 C r8akherm2 C r8akherm2p C r8akherm3 C r8akherm3p C r8bcspeval C r8bcspevxy C r8bcspevfn C r8bcspgrid C r8bcspline C r8bcspvec C r8bpsplinb C r8bpspline C r8cspeval C r8cspevx C r8cspevfn C r8cspline C r8cubsplb C r8dnherm1 C r8dnherm2 C r8dnherm3 C r8evbicub C r8fvbicub C r8fvbicubx C r8evintrp2d C r8fvintrp2d C r8evintrp3d C r8fvintrp3d C r8evspline C r8fvspline C r8evtricub C r8fvtricub C r8fvtricubx C r8f2test C r8f3test C r8genxpkg C r8gridbicub C r8gridherm1 C r8gridherm2 C r8gridherm3 C r8gridintrp2d C r8gridintrp3d C r8gridpc1 C r8gridpc2 C r8gridpc3 C r8gridspline C r8gridtricub C r8herm1ev C r8herm1x C r8herm1fcn C r8herm2ev C r8herm2xy C r8herm2fcn C r8herm2fcnx C r8herm3ev C r8herm3xyz C r8herm3fcn C r8herm3fcnx C r8mkbicub C r8mkbicubw C r8mkbicop C r8mkbicon C r8mkherm1 C r8mkherm2 C r8mkherm3 C r8mkintrp2d C r8mkintrp3d C r8mkspl2pb C r8mkspl2p C r8mkspl2zb C r8mkspl2z C r8mkspl3pb C r8mkspl3zb C r8mkspline C r8mktricub C r8mktricubw C r8mktricop C r8mktricon C r8nspline C r8pc1ev C r8pc1fcn C r8pc2ev C r8pc2fcn C r8pc2fcnx C r8pc3ev C r8pc3fcn C r8pc3fcnx C r8pspline C r8seval2 C r8seval3 C r8seval C r8speval C r8spgrid C r8splaan C r8splbrk C r8spleen C r8splinck C r8spline C r8spvec C r8tcspeval C r8tcspevxyz C r8tcspevfn C r8tcspgrid C r8tcspline C r8tcspcorr C r8tcsp23 C r8tcspvec C r8tpsplinb C r8tpspline C r8util_bcherm1 C r8util_bcherm2 C r8util_bcherm3 C r8vecbicub C r8vecherm1 C r8vecherm2 C r8vecherm3 C r8vecintrp2d C r8vecintrp3d C r8vecpc1 C r8vecpc2 C r8vecpc3 C r8vecspline C r8vectricub C r8v_spline C r8xlookup C r8zonfind C seval2 C seval3 C seval C speval C spgrid C splaan C splbrk C spleen C splinck C spline C spvec C tcspeval C tcspevxyz C tcspevfn C tcspgrid C tcspline C tcspcorr C tcsp23 C tcspvec C tpsplinb C tpspline C util_bcherm1 C util_bcherm2 C util_bcherm3 C vecbicub C vecherm1 C vecherm2 C vecherm3 C vecin2d_argchk C vecin3d_argchk C vecintrp2d C vecintrp3d C vecpc1 C vecpc2 C vecpc3 C vecspline C vectricub C v_spline C xlookup C zonfind N ptrd_mod N read_boozer_mod ► N read_response C clresfun C prfun ► N read_response_nompi C clresfun C prfun N read_v3post_mod N read_wout_mod N realspace ► N reconstruction Defines the base class of the type reconstruction_class . This class contains the minimization algorithm C reconstruction_class Base class containing all the data needed to reconstruct a model N restart_mod Contains routines for writting the restart file N saddle_coils N saddle_surface N shared_data This file contains variables and parameters used by many modules in SIESTA N shared_functions Subroutines and functions updating MHD forces and Wmhd N siesta_bfield This file contains subroutines for updating half-grid magnetic fields ► N siesta_context Defines the base class of the type siesta_context_class . This contains the state variables needed by SIESTA C siesta_context_class Base class representing a siesta_context . This contains a copy of every variable that is needed to define the SIESTA state N siesta_currents Takes the Curl(B) to return the contravariant current density. Contravariant components of the magnetic field must be converted to covariant components first ► N siesta_equilibrium Defines the base class of the type siesta_class . This module contains all the code necessary to interface V3FIT with SIESTA C siesta_class Base class representing a siesta_equilibrium N siesta_error This module contains all the code needed to define an error ► N siesta_file Defines the base class of the type siesta_file_class . This contains the output of a siesta equilibrium C siesta_file_class Base class representing a siesta output N siesta_force Compute the JxB - Grad(p) covariant force components. The plasma is in equilibrium when the force of the magnetic pressure balances the plasma pressure N siesta_namelist This file contains all the variables and maximum sizes of the inputs for a SIESTA namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs N siesta_pressure Updates pressure ► N siesta_run Defines the base class of the type siesta_run_class . This module contains all the code necessary to interface setup and run SIESTA C siesta_run_class Interface for the siesta_run constructor N siesta_state This file contains subroutines for aupdating from t to t + delta_t the magnetic field and pressure as part of the SIESTA project. Stores updated values of JPMN*H, JBSUBXMN*H in Quantities Module ► N signal Defines the base class of the type signal_class C signal_class Base class representing a signal C signal_pointer Pointer to a signal object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly C signal_construct Interface for the construction of signal_class types using signal_construct_new or signal_construct_diagnostic_netcdf ► N signal_dot Defines the base class of type signal_dot_file . This module contains common code used in parsing diagnostic dot files. The actual parsing of the diagnostic dot file is handled by ipch_dot , thscte_dot and sxrch_dot C signal_dot_file Base class representing a diagnostic dot file. This is an opaqe class N spec_kind_mod N spline1_mod N stel_constants N stel_kinds ► N surface_commandline_parser Defines the base class of the type surface_commandline_parser_class C surface_commandline_parser_class Base class containing a parsed surface_commandline ► N surface_context Defines the base class of the type surface_context_class . This module contains all the code necessary define a surface for cariddi to read a virtual surface from C surface_context_class Base class representing a surface context. This contains all memory needed to operate surface N sxrch_dot Module for opening and reading a 'sxrch.' file. The file format for these files are documented in Soft X-Ray Diagnostic Dot File ► N sxrch_t C sxrch_desc ► N sxrem Defines the base class of the type sxrem_class C sxrem_class Base class representing a soft x-ray signal C sxrem_emiss_class Base class representing a soft x-ray emissivity signal C sxrem_ti_class Base class representing a soft x-ray ti signal C sxrem_context Structure to hold all memory needed to be sent to the callback function C sxrem_ti_context Structure to hold all memory needed to be sent to the callback function C sxrem_gp_context_i Structure to hold all memory needed to be sent to the guassian process callback function for point C sxrem_gp_ti_context_i Structure to hold all memory needed to be sent to the guassian process callback function for point C sxrem_gp_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem_gp_ti_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem_gp_context_x Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem_gp_ti_context_x Structure to hold all memory needed to be sent to the guassian process callback function for signal ► N sxrem_ratio Defines a feedback signal based on the temperature based on the ration of the soft x-ray emissivity profile. This signal feeds back the temperature profile at a specified positon C sxrem_ratio_class Base class representing a sxrem_ratio signal N sxrem_ratio_dot Module for opening and reading a 'sxrem_ratio .' file. The file format for these files are documented in Soft X-ray Emissivity Ratio Dot File N sym_check ► N system_mod C system C chdir C getenv C putenv C pxffork C getpid C pxfwait N tf_coils ► N thomson Implements thomson scattering diagnostic. Defines the base class of the type thomson_class C thomson_class Base class representing a thomson scattering signal C thomson_te_class Base class representing a thomson scattering te signal C thomson_ne_class Base class representing a thomson scattering te signal C thomson_p_class Base class representing a thomson scattering te signal N thscte_dot Module for opening and reading a 'thscte.' file. The file format for these files are documented in Thomson Scattering Diagnostic Dot File ► N thscte_t C thscte_desc N timer_mod N timer_sub N tomnsp_mod N totzsp_mod N track_mod ► N unprimed_grid Defines the base class of the type unprimed_grid_class . This contains the state variables to define the currents and positions of the volumn integral C unprimed_grid_class Base class representing a unprimed grid. This is grid the volume integral will be summed over ► N utilities This file contains utilities for converting the siesta grids C to_full_mesh Interface to convert between half and full mesh using either to_full_mesh2 or to_full_mesh3 C to_half_mesh Interface to convert between full and half mesh using either to_half_mesh or to_half_mesh_p C gradienthalf Interface to take the gradianet from full to half mesh using either GradientHalf or GradientHalf_p C curl_htof Interface to take the curl on a half mesh quantity and return a full mesh using either curl_htof or curl_htof_targ C set_bndy_fouier_m0 Interface to set the fouier conditions on a quantity for either scalar set_bndy_fouier_m0 or vector set_bndy_fouier_m0_vec quantities ► N v3_utilities C assert C assert_eq N v3f_vmec_comm ► N v3fit_context Defines a v3fit_context_class object to contain all the memory for running v3fit. Contains methods to write memory to disk C v3fit_context_class Base class representing a v3fit context. This contains all memory needed to operate v3fit N v3fit_input This file contains all the variables and maximum sizes of the inputs for a v3fit namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a V3FIT task should be copied to a v3fit_context object. All non-parameters are inputs to the namelist input file ► N v3fit_params Defines the base class of the type param_class C param_recon_class Class to hold variables needed when a parameter is a reconstruction parameter C param_locking_class Class to hold variables needed when a parameter is a locking parameter. The locking parameter coefficents are stored in the correlation array of the parent type C param_class Base class representing a reconstructed parameter. An upper and lower bound may be set for the parameter value C param_pointer Pointer to a parameter object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly C param_construct Interface for the construction of param_class types using param_construct_basic or param_construct_recon C param_write_step_data Interface for the writting of param_class data to the result file using param_write_step_data_1 or param_write_step_data_2 ► N v3post_rfun C signals ► N v3rfun_context Defines a v3rfun_context_class object to contain all the memory for running v3rfun C v3rfun_context_class Base class representing a v3rfun context. This contains all memory needed to operate v3rfun N v3rfun_input This file contains all the variables and maximum sizes of the inputs for a V3RFUN namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a V3RFUN task should be copied to a v3rfun_context object. All non-parameters are inputs to the namelist input file N vac_persistent ► N vacfield_mod C angles_shifts C write_invac N vacmod N vacmod0 ► N vacuum_equilibrium Defines the base class of the type vacuum_class . This module contains all the code necessary to interface V3FIT with a vacuum equilibrium C vacuum_class Base class representing a vacuum_equilibrium N vacuum_input This file contains all the variables and maximum sizes of the inputs for a vacuum namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a vacuum equilibrium should be copied to a vacuum_equilibrium object. All non-parameters are inputs to the namelist input file N vcoilpts ► N vertex_list C point C magfield C pbfield C vertex C pvertex N vf_coils N vforces ► N vmec_context Defines the base class of the type vmec_context_class . This contains the state variables needed by VMEC C vmec_context_class Base class representing a vmec_context . This contains a copy of every variable that is needed to define the VMEC state N vmec_dim ► N vmec_equilibrium Defines the base class of the type vmec_class . This module contains all the code necessary to interface V3FIT with VMEC C vmec_magnetic_cache Object to cache data needed to compute magnetic signals C vmec_class Base class representing a vmec_equilibrium C runvmec Forward declare the interface for runvmec ► N vmec_file Defines the base class of the type vmec_file_class . This contains the output of a vmec equilibrium C vmec_file_class Base class representing a vmec output N vmec_history N vmec_input This file contains all the variables for a VMEC namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs N vmec_io N vmec_main N vmec_params N vmec_persistent N vmec_seq ► N vmec_test C commandline_parser A radial quantity ► N vmec_utils C getbcyl C getjcyl C mse_pitch N vmercier N vname0 N vname1 N vparams N vspline N vsvd0 ► N write_array_generic C write_array N write_mgrid N write_mod N xstuff ► N gradient_descent Module is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path C gradient_descent_class Base class containing the parameters for the gradient_descent C gradient_descent_test_class Base class containing the parameters for the gradient_descent C check Interface for checking the results of the unit tests ► N guassian_process Defines the base class of the type guassian_process_class. The guassian_process contains code to compuet guassian process profiles C gaussp_class Base class representing a gaussian process C gaussp_class_pointer Pointer to a gaussian process object. Used for creating arrays of gaussian process pointers. This is needed because fortran does not allow arrays of pointers directly ► N hessian C gather_array N init_geometry ► N integration_path Module is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path C integration_path_class Base class containing the parameters of the integration method to use C integration_path_gleg_class Subclass to use Gauss Legendre Quadrature C integration_path_hp_glep_class Subclass to use hp approch C vertex A single point in space defined by an z, y, z coordinate. A vertex is structured as a singly linked list C test_context A type for the test cases C test_search_context A type for the test cases C path_construct Construction interface using path_construct_vertex C path_destruct Destruct interface using path_destruct_vertex C check Interface for checking the results of the unit tests ► N integration_path_context Module is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path C integration_path_context_class Integration context object interface C search_path_context_class Search context object interface C integration_function Interface for the integration function C search_function Interface for the search function ► N intpol Implements interferometry/polarimetry diagnostic. Defines the base class of the type intpol_class C intpol_class Base class representing a interferometer signal C intpol_pol_class Base class representing a polarimetry signal C intpol_int_context Struture to hole all memort needed to be sent to the integration callback function C intpol_pol_context Struture to hole all memort needed to be sent to the integration callback function C intpol_gp_int_context_i Structure to hold all memory needed to be sent to the guassian process callback function of a point C intpol_gp_pol_context_i Structure to hold all memory needed to be sent to the guassian process callback function of a point C intpol_gp_int_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C intpol_gp_pol_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C intpol_gp_int_context_x Structure to hold all memory needed to be sent to the guassian process callback function for position C intpol_gp_pol_context_x Structure to hold all memory needed to be sent to the guassian process callback function for position N ipch_dot Module for opening and reading a 'ipch.' file. The file format for these files are documented in Inteferometry/Polarimetry Diagnostic Dot File ► N ipch_t C ipch_desc N island_params This file contains fix parameters related to the computational grids ► N limiter Defines the base class of the type limiter_class C limiter_class Base class representing a limiter signal ► N limiter_grid Defines the base class of the type limiter_grid_class C limiter_grid_class Base class representing a limiter signal ► N limiter_iso_t Defines the base class of the type limiter_iso C limiter_iso_class Base class representing a limiter_iso function N line_segment Module is part of the LIBSTELL. This module contains code to create a profile constructed of line sigments. These line segments are assumed to be specified such that xx(i) < xx(i + 1) N linear1_mod ► N liprec C li_gbfa C li_gbsl C li_gefa C li_gesl N lmpar_mod ► N m_grid Defines the base class of the type m_grid_class . This contains the state variables to define the vacuum vector potential C m_grid_class Base class representing a m grid. This is grid contains information about the vacuum fields ► N magnetic Defines the base class of the type magnetic_class C magnetic_class Base class representing a magnetic signal ► N magnetic_response Defines the base class of the type magnetic_response_class C magnetic_response_class Base class representing a magnetic signal response function C magnetic_response_construct Interface for the construction of magnetic_response_class types using magnetic_response_construct_new , & magnetic_response_construct_point or & magnetic_response_construct_netcdf N makegrid_global N math_utilities ► N mddc_cdf C mddc_cdf_define C mddc_cdf_write C mddc_cdf_read ► N mddc_t C mddc_mrf C mddc_desc C assignment(=) C mddc_construct C mddc_destroy C mddc_write N metrics Module for reading in VMEC input and computing metric elements on the SIESTA (sqrt-flux) radial grid. Computes and stores the real-space metric elements, Jacobian based on square root of fluc splined vmec coordinate system N mgrid_mod ► N model Defines the base class of the type model_class . The model contains information not specific to the equilibrium C model_class Base class representing a model N model_state Contains parameters defining the bit positions for flags that mark changes in different parts of the model N modular_coils N mpi_inc Umbrella module avoid multiple inlcudes of the mpif.h header N mpi_params ► N mse Implements motional stark effect diagnostic. Defines the base class of the type mse_class C mse_class Base class representing a mse signal N mse_dot Module for opening and reading a 'mse.' file. The file format for these files are documented in Motional Stark Effect Diagnostic Dot File ► N netcdf_inc Work around to fix some netcdf import problems with the Ezcdf. This module emulates the F77 interface using the F90 interface C nf_open Interface to open a file C nf_create Interface to open a file C nf_close Interface to open a file C nf_enddef Interface to inquire a dimension id C nf_strerror Interface to inquire a dimension id C nf_inq_dimid Interface to inquire a dimension id C nf_def_dim Interface to define a dimension C nf_inq_varid Interface to inquire a variable id C nf_get_var_int Interface for reading integer variables C nf_put_var_int Interface for writing integer variables C nf_put_vara_int Interface for writing integer variables C nf_get_var_real Interface for reading real variables. Note double 2D array used by complex real array values C nf_put_vara_real Interface for reading real variables. Note double 2D array used by complex real array values C nf_put_var_real Interface for writing real variables. Note double 2D array used by complex real array values C nf_get_var_double Interface for reading double variables C nf_put_vara_double Interface for reading double variables. Note double 2D array used by complex double array values C nf_put_var_double Interface for writing double variables N nscalingtools N optim_params N packafile N parallel_include_module ► N parallel_vmec_module C copylastntype N pchelms This file solves the helmholtz equation to set inital fields that match vmec and vacuum currents from the vector potential. Initial vector potential on the edge is supplied by the BMW code N perturbation Subroutines and functionsto apply the helical perturbation to open up islands ► N pprofile_t Defines the base class of the type pprofile_class . This module contains all the code necessary to define parameterized profiles C pprofile_class Base class representing a parameterized profile C pprofile_pointer Pointer to a pprofile object. Used for creating arrays of pprofile pointers. This is needed because fortran does not allow arrays of pointers directly N precon2d ► N primed_grid Defines the base class of the type primed_grid_class . This contains the state variables to define the currents and positions of the volumn integral C primed_grid_class Base class representing a primed grid. This is grid the volume integral will be summed over ► N prior_gaussian Defines the base class of the type prior_gaussian_class . This class implements priors of the type C prior_gaussian_class Base class representing a prior_guassian signal N prof_mod ► N profiler Defines functions for measuring an tabulating performance of function and subroutine calls. These routines are only active when the PROFILE_ON macro is defined C profiler_bucket Full table of profiled functions ► N pspline_calls C akherm1 C akherm1p C akherm0 C akherm2 C akherm2p C akherm3 C akherm3p C bcspeval C bcspevxy C bcspevfn C bcspgrid C bcspline C bcspvec C bpsplinb C bpspline C cspeval C cspevx C cspevfn C cspline C cubsplb C dnherm1 C dnherm2 C dnherm3 C evbicub C fvbicub C fvbicubx C evintrp2d C fvintrp2d C evintrp3d C fvintrp3d C evspline C fvspline C evtricub C fvtricub C fvtricubx C f2test C f3test C genxpkg C gridbicub C gridherm1 C gridherm2 C gridherm3 C gridintrp2d C gridintrp3d C gridpc1 C gridpc2 C gridpc3 C gridspline C gridtricub C herm1ev C herm1x C herm1fcn C herm2ev C herm2xy C herm2fcn C herm2fcnx C herm3ev C herm3xyz C herm3fcn C herm3fcnx C ibc_ck C mkbicub C mkbicubw C mkbicop C mkbicon C mkherm1 C mkherm2 C mkherm3 C mkintrp2d C mkintrp3d C mkspl2pb C mkspl2p C mkspl2zb C mkspl2z C mkspl3pb C mkspl3zb C mkspline C mktricub C mktricubw C mktricop C mktricon C nspline C pc1ev C pc1fcn C pc2ev C pc2fcn C pc2fcnx C pc3ev C pc3fcn C pc3fcnx C pspline C r8akherm1 C r8akherm1p C r8akherm0 C r8akherm2 C r8akherm2p C r8akherm3 C r8akherm3p C r8bcspeval C r8bcspevxy C r8bcspevfn C r8bcspgrid C r8bcspline C r8bcspvec C r8bpsplinb C r8bpspline C r8cspeval C r8cspevx C r8cspevfn C r8cspline C r8cubsplb C r8dnherm1 C r8dnherm2 C r8dnherm3 C r8evbicub C r8fvbicub C r8fvbicubx C r8evintrp2d C r8fvintrp2d C r8evintrp3d C r8fvintrp3d C r8evspline C r8fvspline C r8evtricub C r8fvtricub C r8fvtricubx C r8f2test C r8f3test C r8genxpkg C r8gridbicub C r8gridherm1 C r8gridherm2 C r8gridherm3 C r8gridintrp2d C r8gridintrp3d C r8gridpc1 C r8gridpc2 C r8gridpc3 C r8gridspline C r8gridtricub C r8herm1ev C r8herm1x C r8herm1fcn C r8herm2ev C r8herm2xy C r8herm2fcn C r8herm2fcnx C r8herm3ev C r8herm3xyz C r8herm3fcn C r8herm3fcnx C r8mkbicub C r8mkbicubw C r8mkbicop C r8mkbicon C r8mkherm1 C r8mkherm2 C r8mkherm3 C r8mkintrp2d C r8mkintrp3d C r8mkspl2pb C r8mkspl2p C r8mkspl2zb C r8mkspl2z C r8mkspl3pb C r8mkspl3zb C r8mkspline C r8mktricub C r8mktricubw C r8mktricop C r8mktricon C r8nspline C r8pc1ev C r8pc1fcn C r8pc2ev C r8pc2fcn C r8pc2fcnx C r8pc3ev C r8pc3fcn C r8pc3fcnx C r8pspline C r8seval2 C r8seval3 C r8seval C r8speval C r8spgrid C r8splaan C r8splbrk C r8spleen C r8splinck C r8spline C r8spvec C r8tcspeval C r8tcspevxyz C r8tcspevfn C r8tcspgrid C r8tcspline C r8tcspcorr C r8tcsp23 C r8tcspvec C r8tpsplinb C r8tpspline C r8util_bcherm1 C r8util_bcherm2 C r8util_bcherm3 C r8vecbicub C r8vecherm1 C r8vecherm2 C r8vecherm3 C r8vecintrp2d C r8vecintrp3d C r8vecpc1 C r8vecpc2 C r8vecpc3 C r8vecspline C r8vectricub C r8v_spline C r8xlookup C r8zonfind C seval2 C seval3 C seval C speval C spgrid C splaan C splbrk C spleen C splinck C spline C spvec C tcspeval C tcspevxyz C tcspevfn C tcspgrid C tcspline C tcspcorr C tcsp23 C tcspvec C tpsplinb C tpspline C util_bcherm1 C util_bcherm2 C util_bcherm3 C vecbicub C vecherm1 C vecherm2 C vecherm3 C vecin2d_argchk C vecin3d_argchk C vecintrp2d C vecintrp3d C vecpc1 C vecpc2 C vecpc3 C vecspline C vectricub C v_spline C xlookup C zonfind N ptrd_mod N read_boozer_mod ► N read_response C clresfun C prfun ► N read_response_nompi C clresfun C prfun N read_v3post_mod N read_wout_mod N realspace ► N reconstruction Defines the base class of the type reconstruction_class . This class contains the minimization algorithm C reconstruction_class Base class containing all the data needed to reconstruct a model N restart_mod Contains routines for writting the restart file N saddle_coils N saddle_surface N shared_data This file contains variables and parameters used by many modules in SIESTA N shared_functions Subroutines and functions updating MHD forces and Wmhd N siesta_bfield This file contains subroutines for updating half-grid magnetic fields ► N siesta_context Defines the base class of the type siesta_context_class . This contains the state variables needed by SIESTA C siesta_context_class Base class representing a siesta_context . This contains a copy of every variable that is needed to define the SIESTA state N siesta_currents Takes the Curl(B) to return the contravariant current density. Contravariant components of the magnetic field must be converted to covariant components first ► N siesta_equilibrium Defines the base class of the type siesta_class . This module contains all the code necessary to interface V3FIT with SIESTA C siesta_class Base class representing a siesta_equilibrium N siesta_error This module contains all the code needed to define an error ► N siesta_file Defines the base class of the type siesta_file_class . This contains the output of a siesta equilibrium C siesta_file_class Base class representing a siesta output N siesta_force Compute the JxB - Grad(p) covariant force components. The plasma is in equilibrium when the force of the magnetic pressure balances the plasma pressure N siesta_namelist This file contains all the variables and maximum sizes of the inputs for a SIESTA namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs N siesta_pressure Updates pressure ► N siesta_run Defines the base class of the type siesta_run_class . This module contains all the code necessary to interface setup and run SIESTA C siesta_run_class Interface for the siesta_run constructor N siesta_state This file contains subroutines for aupdating from t to t + delta_t the magnetic field and pressure as part of the SIESTA project. Stores updated values of JPMN*H, JBSUBXMN*H in Quantities Module ► N signal Defines the base class of the type signal_class C signal_class Base class representing a signal C signal_pointer Pointer to a signal object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly C signal_construct Interface for the construction of signal_class types using signal_construct_new or signal_construct_diagnostic_netcdf ► N signal_dot Defines the base class of type signal_dot_file . This module contains common code used in parsing diagnostic dot files. The actual parsing of the diagnostic dot file is handled by ipch_dot , thscte_dot and sxrch_dot C signal_dot_file Base class representing a diagnostic dot file. This is an opaqe class N spec_kind_mod N spline1_mod N stel_constants N stel_kinds ► N surface_commandline_parser Defines the base class of the type surface_commandline_parser_class C surface_commandline_parser_class Base class containing a parsed surface_commandline ► N surface_context Defines the base class of the type surface_context_class . This module contains all the code necessary define a surface for cariddi to read a virtual surface from C surface_context_class Base class representing a surface context. This contains all memory needed to operate surface N sxrch_dot Module for opening and reading a 'sxrch.' file. The file format for these files are documented in Soft X-Ray Diagnostic Dot File ► N sxrch_t C sxrch_desc ► N sxrem Defines the base class of the type sxrem_class C sxrem_class Base class representing a soft x-ray signal C sxrem_emiss_class Base class representing a soft x-ray emissivity signal C sxrem_ti_class Base class representing a soft x-ray ti signal C sxrem_context Structure to hold all memory needed to be sent to the callback function C sxrem_ti_context Structure to hold all memory needed to be sent to the callback function C sxrem_gp_context_i Structure to hold all memory needed to be sent to the guassian process callback function for point C sxrem_gp_ti_context_i Structure to hold all memory needed to be sent to the guassian process callback function for point C sxrem_gp_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem_gp_ti_context_s Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem_gp_context_x Structure to hold all memory needed to be sent to the guassian process callback function for signal C sxrem_gp_ti_context_x Structure to hold all memory needed to be sent to the guassian process callback function for signal ► N sxrem_ratio Defines a feedback signal based on the temperature based on the ration of the soft x-ray emissivity profile. This signal feeds back the temperature profile at a specified positon C sxrem_ratio_class Base class representing a sxrem_ratio signal N sxrem_ratio_dot Module for opening and reading a 'sxrem_ratio .' file. The file format for these files are documented in Soft X-ray Emissivity Ratio Dot File N sym_check ► N system_mod C system C chdir C getenv C putenv C pxffork C getpid C pxfwait N tf_coils ► N thomson Implements thomson scattering diagnostic. Defines the base class of the type thomson_class C thomson_class Base class representing a thomson scattering signal C thomson_te_class Base class representing a thomson scattering te signal C thomson_ne_class Base class representing a thomson scattering te signal C thomson_p_class Base class representing a thomson scattering te signal N thscte_dot Module for opening and reading a 'thscte.' file. The file format for these files are documented in Thomson Scattering Diagnostic Dot File ► N thscte_t C thscte_desc N timer_mod N timer_sub N tomnsp_mod N totzsp_mod N track_mod ► N unprimed_grid Defines the base class of the type unprimed_grid_class . This contains the state variables to define the currents and positions of the volumn integral C unprimed_grid_class Base class representing a unprimed grid. This is grid the volume integral will be summed over ► N utilities This file contains utilities for converting the siesta grids C to_full_mesh Interface to convert between half and full mesh using either to_full_mesh2 or to_full_mesh3 C to_half_mesh Interface to convert between full and half mesh using either to_half_mesh or to_half_mesh_p C gradienthalf Interface to take the gradianet from full to half mesh using either GradientHalf or GradientHalf_p C curl_htof Interface to take the curl on a half mesh quantity and return a full mesh using either curl_htof or curl_htof_targ C set_bndy_fouier_m0 Interface to set the fouier conditions on a quantity for either scalar set_bndy_fouier_m0 or vector set_bndy_fouier_m0_vec quantities ► N v3_utilities C assert C assert_eq N v3f_vmec_comm ► N v3fit_context Defines a v3fit_context_class object to contain all the memory for running v3fit. Contains methods to write memory to disk C v3fit_context_class Base class representing a v3fit context. This contains all memory needed to operate v3fit N v3fit_input This file contains all the variables and maximum sizes of the inputs for a v3fit namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a V3FIT task should be copied to a v3fit_context object. All non-parameters are inputs to the namelist input file ► N v3fit_params Defines the base class of the type param_class C param_recon_class Class to hold variables needed when a parameter is a reconstruction parameter C param_locking_class Class to hold variables needed when a parameter is a locking parameter. The locking parameter coefficents are stored in the correlation array of the parent type C param_class Base class representing a reconstructed parameter. An upper and lower bound may be set for the parameter value C param_pointer Pointer to a parameter object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly C param_construct Interface for the construction of param_class types using param_construct_basic or param_construct_recon C param_write_step_data Interface for the writting of param_class data to the result file using param_write_step_data_1 or param_write_step_data_2 ► N v3post_rfun C signals ► N v3rfun_context Defines a v3rfun_context_class object to contain all the memory for running v3rfun C v3rfun_context_class Base class representing a v3rfun context. This contains all memory needed to operate v3rfun N v3rfun_input This file contains all the variables and maximum sizes of the inputs for a V3RFUN namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a V3RFUN task should be copied to a v3rfun_context object. All non-parameters are inputs to the namelist input file N vac_persistent ► N vacfield_mod C angles_shifts C write_invac N vacmod N vacmod0 ► N vacuum_equilibrium Defines the base class of the type vacuum_class . This module contains all the code necessary to interface V3FIT with a vacuum equilibrium C vacuum_class Base class representing a vacuum_equilibrium N vacuum_input This file contains all the variables and maximum sizes of the inputs for a vacuum namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a vacuum equilibrium should be copied to a vacuum_equilibrium object. All non-parameters are inputs to the namelist input file N vcoilpts ► N vertex_list C point C magfield C pbfield C vertex C pvertex N vf_coils N vforces ► N vmec_context Defines the base class of the type vmec_context_class . This contains the state variables needed by VMEC C vmec_context_class Base class representing a vmec_context . This contains a copy of every variable that is needed to define the VMEC state N vmec_dim ► N vmec_equilibrium Defines the base class of the type vmec_class . This module contains all the code necessary to interface V3FIT with VMEC C vmec_magnetic_cache Object to cache data needed to compute magnetic signals C vmec_class Base class representing a vmec_equilibrium C runvmec Forward declare the interface for runvmec ► N vmec_file Defines the base class of the type vmec_file_class . This contains the output of a vmec equilibrium C vmec_file_class Base class representing a vmec output N vmec_history N vmec_input This file contains all the variables for a VMEC namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs N vmec_io N vmec_main N vmec_params N vmec_persistent N vmec_seq ► N vmec_test C commandline_parser A radial quantity ► N vmec_utils C getbcyl C getjcyl C mse_pitch N vmercier N vname0 N vname1 N vparams N vspline N vsvd0 ► N write_array_generic C write_array N write_mgrid N write_mod N xstuff Stellarator-Tools: Member List
+
+
+
+
+
+
+ Stellarator-Tools
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for gradient_descent::gradient_descent_class , including all inherited members.
+
+
Stellarator-Tools: gradient_descent::gradient_descent_class Type Reference
+
+
+
+
+
+
+ Stellarator-Tools
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Base class containing the parameters for the gradient_descent .
+ More...
+
+
+
+
+
+
+
+
+step Step size to use. tolarance Minimization tolarance. x_var => null() Variables.
+
+
Base class containing the parameters for the gradient_descent .
+
The documentation for this type was generated from the following file:
+
+
Stellarator-Tools: Member List
+
+
+
+
+
+
+ Stellarator-Tools
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for gradient_descent::gradient_descent_test_class , including all inherited members.
+
+
Stellarator-Tools: gradient_descent::gradient_descent_test_class Interface Reference
+
+
+
+
+
+
+ Stellarator-Tools
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Base class containing the parameters for the gradient_descent .
+ More...
+
+
+
+
+
+
+
+
+step Step size to use. tolarance Minimization tolarance. x_var => null() Variables.
+
+
Base class containing the parameters for the gradient_descent .
+
+
+
◆
+
+
+
+
+
+ class (gradient_descent_test_class ) function, pointer gradient_descent::gradient_descent_test_class::gradient_descent_test_construct
+
+
+
+
+
The documentation for this interface was generated from the following file:
+
+
1.9.1
+ 
+
+
+
+
Public Member Functions inherited from gradient_descent::gradient_descent_class