ALL Fortran module
Due to the case insensitive nature of Fortran and the used toolchain
(doxygen and sphinx), all variables and function names are lowercase on
this page. We do, however, use only upper case for global constants, such
as the load balancing methods (ALL_STAGGERED
etc.) and the function
names are usually written similarly to MPI as ALL_get_work
. The object
is of type(ALL_t)
.
Methods
Available methods are:
- integer(c_int), parameter, public all_module::all_forcebased = 2
- integer(c_int), parameter, public all_module::all_histogram = 4
- integer(c_int), parameter, public all_module::all_staggered = 0
- integer(c_int), parameter, public all_module::all_tensor = 1
- integer(c_int), parameter, public all_module::all_voronoi = 3
Errors
The exceptions map to the following error constants:
- integer(c_int), parameter, public all_module::all_error_filesystem = 6
- integer(c_int), parameter, public all_module::all_error_generic = 1
- integer(c_int), parameter, public all_module::all_error_internal = 6
- integer(c_int), parameter, public all_module::all_error_invalidargument = 4
- integer(c_int), parameter, public all_module::all_error_invalidcommtype = 3
- integer(c_int), parameter, public all_module::all_error_outofbounds = 5
- integer(c_int), parameter, public all_module::all_error_pointdimensionmissmatch = 2
And the error message is returned in a string of length
ALL_ERROR_LENGTH
.
Functions
These function all have a corresponding call in the object, with the
ALL_
stripped from the function name. So with an object named
balancer
the function ALL_get_work(balancer, work)
is identical to
balancer%get_work(work)
. The following functions are available:
Warning
doxygenfunction: Unable to resolve function “all_balance” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_balance (this) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_balance (this) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_balance (this) ———-^
Warning
doxygenfunction: Unable to resolve function “all_finalize” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_finalize (this) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_finalize (this) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_finalize (this) ———-^
Warning
doxygenfunction: Unable to resolve function “all_setup” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_setup (this) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_setup (this) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_setup (this) ———-^
Getters
Warning
doxygenfunction: Unable to resolve function “all_get_dimension” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_dimension (this, dim) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_dimension (this, dim) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_dimension (this, dim) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_gamma” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_gamma (this, gamma) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_gamma (this, gamma) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_gamma (this, gamma) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_length_of_work” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_length_of_work (this, length) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_length_of_work (this, length) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_length_of_work (this, length) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_neighbors” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_neighbors (this, neighbors) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_neighbors (this, neighbors) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_neighbors (this, neighbors) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_number_of_neighbors” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_number_of_neighbors (this, count) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_number_of_neighbors (this, count) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_number_of_neighbors (this, count) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_number_of_vertices” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_number_of_vertices (this, n) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_number_of_vertices (this, n) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_number_of_vertices (this, n) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_prev_vertices” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_prev_vertices (this, vertices) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_prev_vertices (this, vertices) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_prev_vertices (this, vertices) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_vertices” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_vertices (this, vertices) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_vertices (this, vertices) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_vertices (this, vertices) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_vertices_alloc” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_vertices_alloc (this, vertices) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_vertices_alloc (this, vertices) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_vertices_alloc (this, vertices) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_work” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_work (this, work) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_work (this, work) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_work (this, work) ———-^
Warning
doxygenfunction: Unable to resolve function “all_get_work_array” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_get_work_array (this, work) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_work_array (this, work) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_get_work_array (this, work) ———-^
Setters
Warning
doxygenfunction: Unable to resolve function “all_set_gamma” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_gamma (this, gamma) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_gamma (this, gamma) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_gamma (this, gamma) ———-^
Warning
doxygenfunction: Unable to resolve function “all_set_method_data_histgram” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_method_data_histgram (this, nbins) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_method_data_histgram (this, nbins) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_method_data_histgram (this, nbins) ———-^
Warning
doxygenfunction: Unable to resolve function “all_set_min_domain_size” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_min_domain_size (this, domain_size) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_min_domain_size (this, domain_size) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_min_domain_size (this, domain_size) ———-^
Warning
doxygenfunction: Unable to resolve function “all_set_proc_grid_params” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_proc_grid_params (this, loc, ranks) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_proc_grid_params (this, loc, ranks) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_proc_grid_params (this, loc, ranks) ———-^
Warning
doxygenfunction: Unable to resolve function “all_set_proc_tag” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_proc_tag (this, tag) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_proc_tag (this, tag) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_proc_tag (this, tag) ———-^
Warning
doxygenfunction: Unable to resolve function “all_set_sys_size” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_sys_size (this, syssize) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_sys_size (this, syssize) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_sys_size (this, syssize) ———-^
Warning
doxygenfunction: Unable to resolve function “all_set_vertices” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_vertices (this, vertices) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_vertices (this, vertices) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_vertices (this, vertices) ———-^
Warning
doxygenfunction: Unable to resolve function “all_set_work” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_work (this, work) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_work (this, work) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_work (this, work) ———-^
Warning
doxygenfunction: Unable to resolve function “all_set_work_multi” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_set_work_multi (this, work) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_work_multi (this, work) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_set_work_multi (this, work) ———-^
Output
Warning
doxygenfunction: Unable to resolve function “all_print_vtk_outlines” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_print_vtk_outlines (this, step) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_print_vtk_outlines (this, step) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_print_vtk_outlines (this, step) ———-^
Warning
doxygenfunction: Unable to resolve function “all_print_vtk_vertices” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_print_vtk_vertices (this, step) ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_print_vtk_vertices (this, step) ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_print_vtk_vertices (this, step) ———-^
Error handling
Warning
doxygenfunction: Unable to resolve function “all_error” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 8] integer function, public all_error () ——–^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected ‘::’ in pointer to member (function). [error at 16] integer function, public all_error () —————-^ If declarator-id: Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 16] integer function, public all_error () —————-^
Warning
doxygenfunction: Unable to resolve function “all_error_description” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Invalid C++ declaration: Expected end of definition or ;. [error at 32] character(len=all_error_length) function, public all_error_description () ——————————–^ If the function has a return type: Error in declarator If declarator-id with parameters-and-qualifiers: Invalid C++ declaration: Expected identifier in nested name. [error at 9] character(len=all_error_length) function, public all_error_description () ———^ If parenthesis in noptr-declarator: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected ‘::’ in pointer to member (function). [error at 13] character(len=all_error_length) function, public all_error_description () ————-^ If declarator-id: Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 13] character(len=all_error_length) function, public all_error_description () ————-^
Warning
doxygenfunction: Unable to resolve function “all_reset_error” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 10] subroutine, public all_reset_error () ———-^ If the function has a return type: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_reset_error () ———-^ If declarator-id: Invalid C++ declaration: Expected identifier in nested name. [error at 10] subroutine, public all_reset_error () ———-^