| 
| procedure, pass(this)  | init (this, json, case) | 
|   | Initialize from json.  
  | 
|   | 
| procedure, pass(this)  | init_from_attributes (this, dof, output_file) | 
|   | Initialize without json things.  
  | 
|   | 
| procedure, pass(this)  | free (this) | 
|   | Destructor.  
  | 
|   | 
| procedure, pass(this)  | setup_offset (this) | 
|   | Setup offset for I/O when using sequential write/read from rank 0.  
  | 
|   | 
| procedure, pass(this)  | compute_ (this, t, tstep) | 
|   | Interpolate each probe from its r,s,t coordinates.  
  | 
|   | 
| procedure, pass(this)  | init_base (this, json, case) | 
|   | Constructor for the simulation_component_t (base) class.  
  | 
|   | 
| procedure, pass(this)  | free_base (this) | 
|   | Destructor for the simulation_component_t (base) class.  
  | 
|   | 
| procedure, pass(this)  | restart (this, t) | 
|   | Wrapper for calling set_counter for the time based controllers. Serves as the public interface.  
  | 
|   | 
| procedure, pass(this)  | preprocess (this, t, tstep) | 
|   | Wrapper for calling preprocess_ based on the preprocess_controller. Serves as the public interface.  
  | 
|   | 
| procedure, pass(this)  | compute (this, t, tstep) | 
|   | Wrapper for calling compute_ based on the compute_controller. Serves as the public interface.  
  | 
|   | 
| procedure(simulation_component_init), deferred, pass  | init (this, json, case) | 
|   | The common constructor using a JSON dictionary.  
  | 
|   | 
| procedure(simulation_component_free), deferred, pass  | free (this) | 
|   | Destructor.  
  | 
|   | 
| procedure, pass(this)  | preprocess_ (this, t, tstep) | 
|   | The preprocessing function to be executed during the run.  
  | 
|   | 
| procedure, pass(this)  | compute_ (this, t, tstep) | 
|   | The main function to be executed during the run.  
  | 
|   | 
| procedure, pass(this)  | restart_ (this, t) | 
|   | The restart function to be called upon restarting simulation.  
  | 
|   | 
 | 
| integer  | n_fields = 0 | 
|   | Number of output fields.  
  | 
|   | 
| type(global_interpolation_t)  | global_interp | 
|   | 
| integer  | n_global_probes | 
|   | Global number of probes (needed for i/o)  
  | 
|   | 
| integer  | n_probes_offset | 
|   | global offset for writing  
  | 
|   | 
| real(kind=rp), dimension(:,:), allocatable  | xyz | 
|   | x,y,z coordinates  
  | 
|   | 
| real(kind=rp), dimension(:,:), allocatable  | out_values | 
|   | Interpolated values.  
  | 
|   | 
| type(c_ptr), dimension(:), allocatable  | out_values_d | 
|   | 
| real(kind=rp), dimension(:,:), allocatable  | out_vals_trsp | 
|   | 
| integer  | n_local_probes | 
|   | Number of local elements per rank.  
  | 
|   | 
| type(field_list_t)  | sampled_fields | 
|   | Fields to be probed.  
  | 
|   | 
| character(len=20), dimension(:), allocatable  | which_fields | 
|   | 
| integer, dimension(:), allocatable  | n_local_probes_tot_offset | 
|   | Allocated on rank 0.  
  | 
|   | 
| integer, dimension(:), allocatable  | n_local_probes_tot | 
|   | 
| logical  | seq_io | 
|   | For output on rank 0.  
  | 
|   | 
| real(kind=rp), dimension(:,:), allocatable  | global_output_values | 
|   | 
| type(file_t)  | fout | 
|   | Output variables.  
  | 
|   | 
| type(matrix_t)  | mat_out | 
|   | 
| type(case_t), pointer  | case | 
|   | Pointer to the simulation case.  
  | 
|   | 
| type(time_based_controller_t)  | preprocess_controller | 
|   | Controller for when to run preprocess.  
  | 
|   | 
| type(time_based_controller_t)  | compute_controller | 
|   | Controller for when to run compute.  
  | 
|   | 
| type(time_based_controller_t)  | output_controller | 
|   | Controller for when to do output.  
  | 
|   | 
| integer  | order | 
|   | The execution order, lowest excutes first.  
  | 
|   | 
 | 
| procedure, pass(this), private  | read_file (this, json) | 
|   | Reader for file type points.  
  | 
|   | 
| procedure, pass(this), private  | read_point (this, json) | 
|   | Reader for point type points.  
  | 
|   | 
| procedure, pass(this), private  | read_line (this, json) | 
|   | Reader for line type points.  
  | 
|   | 
| procedure, pass(this), private  | read_circle (this, json) | 
|   | Reader for circle type points.  
  | 
|   | 
| procedure, pass(this), private  | read_point_zone (this, json, dof) | 
|   | Reader for point zone type points.  
  | 
|   | 
| procedure, pass(this), private  | add_points (this, new_points) | 
|   | Append a new list of points to the exsiting list.  
  | 
|   | 
Definition at line 61 of file probes.F90.
 
◆ add_points()
- Parameters
 - 
  
    | [in,out] | this | The probes object.  | 
    | [in] | new_points | The new points to be appended.  | 
  
   
Definition at line 117 of file probes.F90.
 
 
◆ compute()
◆ compute_() [1/2]
- Note
 - The final interpolated field is only available on rank 0. 
 
- Parameters
 - 
  
    | t | Current simulation time.  | 
    | tstep | Current time step.  | 
  
   
Definition at line 100 of file probes.F90.
 
 
◆ compute_() [2/2]
◆ free() [1/2]
◆ free() [2/2]
◆ free_base()
◆ init() [1/2]
◆ init() [2/2]
◆ init_base()
- Parameters
 - 
  
    | object | The object to be created and initialized.  | 
    | json | JSON object initializing the simulation component.  | 
    | case | The simulation case. Constructor for the simulation_component_t (base) class.  | 
  
   
Definition at line 61 of file simulation_component.f90.
 
 
◆ init_from_attributes()
- Parameters
 - 
  
    | dof | Dofmap to probe @output_file Name of output file, current must be CSV  | 
  
   
Definition at line 93 of file probes.F90.
 
 
◆ preprocess()
◆ preprocess_()
◆ read_circle()
The general structure of the circle is defined by a center point, a radius and a normal to the plane it lies on. The circle is then discretized into a number of points, based on the amount parameter. The points are added clockwise starting from a chosen axis, which is defined by the axis parameter. 
- Note
 - The axis must be one of the following: 
x, y, or z.  
- Parameters
 - 
  
    | [in,out] | this | The probes object.  | 
    | [in,out] | json | The json file object.  | 
  
   
Definition at line 112 of file probes.F90.
 
 
◆ read_file()
- Note
 - The points are expected to be in the form of a list of coordinates. 
 
- Parameters
 - 
  
    | [in,out] | this | The probes object.  | 
    | [in,out] | json | The json file object.  | 
  
   
Definition at line 106 of file probes.F90.
 
 
◆ read_line()
- Parameters
 - 
  
    | [in,out] | this | The probes object.  | 
    | [in,out] | json | The json file object.  | 
  
   
Definition at line 110 of file probes.F90.
 
 
◆ read_point()
- Note
 - The points are expected to be in the form of a list of coordinates. 
 
- Parameters
 - 
  
    | [in,out] | this | The probes object.  | 
    | [in,out] | json | The json file object.  | 
  
   
Definition at line 108 of file probes.F90.
 
 
◆ read_point_zone()
The GLL points are read from the point zone and added to the probe list. 
- Parameters
 - 
  
    | [in,out] | this | The probes object.  | 
    | [in,out] | json | The json file object.  | 
  
   
Definition at line 114 of file probes.F90.
 
 
◆ restart()
◆ restart_()
◆ setup_offset()
◆ case
  
  
      
        
          | type(case_t), pointer simulation_component::simulation_component_t::case | 
         
       
   | 
  
inherited   | 
  
 
 
◆ compute_controller
  
  
      
        
          | type(time_based_controller_t) simulation_component::simulation_component_t::compute_controller | 
         
       
   | 
  
inherited   | 
  
 
 
◆ fout
      
        
          | type(file_t) probes::probes_t::fout | 
        
      
 
 
◆ global_interp
◆ global_output_values
◆ mat_out
      
        
          | type(matrix_t) probes::probes_t::mat_out | 
        
      
 
 
◆ n_fields
      
        
          | integer probes::probes_t::n_fields = 0 | 
        
      
 
 
◆ n_global_probes
      
        
          | integer probes::probes_t::n_global_probes | 
        
      
 
 
◆ n_local_probes
      
        
          | integer probes::probes_t::n_local_probes | 
        
      
 
 
◆ n_local_probes_tot
◆ n_local_probes_tot_offset
◆ n_probes_offset
      
        
          | integer probes::probes_t::n_probes_offset | 
        
      
 
 
◆ order
  
  
      
        
          | integer simulation_component::simulation_component_t::order | 
         
       
   | 
  
inherited   | 
  
 
 
◆ out_vals_trsp
◆ out_values
◆ out_values_d
◆ output_controller
  
  
      
        
          | type(time_based_controller_t) simulation_component::simulation_component_t::output_controller | 
         
       
   | 
  
inherited   | 
  
 
 
◆ preprocess_controller
  
  
      
        
          | type(time_based_controller_t) simulation_component::simulation_component_t::preprocess_controller | 
         
       
   | 
  
inherited   | 
  
 
 
◆ sampled_fields
◆ seq_io
◆ which_fields
◆ xyz
The documentation for this type was generated from the following file:
- /home/runner/work/neko/neko/src/simulation_components/probes.F90