Skip to content

Commit 77fa207

Browse files
pcarruscagpcarruscag
authored
Merge pull request #1978 from su2code/consistent_py_wrapper_func_names
Consistent python wrapper function names
2 parents 790de98 + c6b2f24 commit 77fa207

13 files changed

Lines changed: 269 additions & 491 deletions

File tree

‎SU2_CFD/include/drivers/CDriver.hpp‎

Lines changed: 3 additions & 124 deletions
Original file line numberDiff line numberDiff line change
@@ -256,12 +256,13 @@ class CDriver : public CDriverBase {
256256
CVolumetricMovement*& grid_movement, CSurfaceMovement*& surface_movement) const;
257257

258258
/*!
259-
* \brief Initialize Python interface functionalities
259+
* \brief Initialize Python interface functionalities. When using multigrid,
260+
* it is important to call this after modifying custom boundary values.
260261
* \param[in] config - Definition of the particular problem.
261262
* \param[in] geometry - Geometrical definition of the problem.
262263
* \param[in] solver - Container vector with all the solutions.
263264
*/
264-
void PythonInterface_Preprocessing(CConfig** config, CGeometry**** geometry, CSolver***** solver);
265+
void PythonInterfacePreprocessing(CConfig** config, CGeometry**** geometry, CSolver***** solver);
265266

266267
/*!
267268
* \brief Preprocess the output container.
@@ -477,54 +478,6 @@ class CDriver : public CDriverBase {
477478
*/
478479
string GetSurfaceFileName() const;
479480

480-
/*!
481-
* \brief Get the temperature at a vertex on a specified marker.
482-
* \param[in] iMarker - Marker identifier.
483-
* \param[in] iVertex - Vertex identifier.
484-
* \return Temperature of the vertex.
485-
*/
486-
passivedouble GetVertexTemperature(unsigned short iMarker, unsigned long iVertex) const;
487-
488-
/*!
489-
* \brief Set the temperature of a vertex on a specified marker.
490-
* \param[in] iMarker - Marker identifier.
491-
* \param[in] iVertex - Vertex identifier.
492-
* \param[in] val_WallTemp - Value of the temperature.
493-
*/
494-
void SetVertexTemperature(unsigned short iMarker, unsigned long iVertex, passivedouble val_WallTemp);
495-
496-
/*!
497-
* \brief Get the heat flux at a vertex on a specified marker (3 components).
498-
* \param[in] iMarker - Marker identifier.
499-
* \param[in] iVertex - Vertex identifier.
500-
* \return True if the vertex is a halo node.
501-
*/
502-
vector<passivedouble> GetVertexHeatFluxes(unsigned short iMarker, unsigned long iVertex) const;
503-
504-
/*!
505-
* \brief Get the wall normal component of the heat flux at a vertex on a specified marker.
506-
* \param[in] iMarker - Marker identifier.
507-
* \param[in] iVertex - Vertex identifier.
508-
* \return Wall normal component of the heat flux at the vertex.
509-
*/
510-
passivedouble GetVertexNormalHeatFlux(unsigned short iMarker, unsigned long iVertex) const;
511-
512-
/*!
513-
* \brief Set the wall normal component of the heat flux at a vertex on a specified marker.
514-
* \param[in] iMarker - Marker identifier.
515-
* \param[in] iVertex - Vertex identifier.
516-
* \param[in] val_WallHeatFlux - Value of the normal heat flux.
517-
*/
518-
void SetVertexNormalHeatFlux(unsigned short iMarker, unsigned long iVertex, passivedouble val_WallHeatFlux);
519-
520-
/*!
521-
* \brief Get the thermal conductivity at a vertex on a specified marker.
522-
* \param[in] iMarker - Marker identifier.
523-
* \param[in] iVertex - Vertex identifier.
524-
* \return Thermal conductivity at the vertex.
525-
*/
526-
passivedouble GetThermalConductivity(unsigned short iMarker, unsigned long iVertex) const;
527-
528481
/*!
529482
* \brief Preprocess the inlets via file input for all solvers.
530483
* \param[in] solver_container - Container vector with all the solutions.
@@ -533,80 +486,6 @@ class CDriver : public CDriverBase {
533486
*/
534487
void Inlet_Preprocessing(CSolver*** solver, CGeometry** geometry, CConfig* config) const;
535488

536-
/*!
537-
* \brief Get all the CHT boundary marker tags.
538-
* \return List of CHT boundary markers tags.
539-
*/
540-
vector<string> GetCHTMarkerTags() const;
541-
542-
/*!
543-
* \brief Get all the inlet boundary marker tags.
544-
* \return List of inlet boundary markers tags.
545-
*/
546-
vector<string> GetInletMarkerTags() const;
547-
548-
/*!
549-
* \brief Return the sensitivities of the mesh boundary vertices.
550-
* \param[in] iMarker - Marker identifier.
551-
* \param[in] iVertex - Vertex identifier.
552-
* \return Vector of sensitivities.
553-
*/
554-
vector<passivedouble> GetMeshDisp_Sensitivity(unsigned short iMarker, unsigned long iVertex) const;
555-
556-
/*!
557-
* \brief Set the load in X direction for the structural solver.
558-
* \param[in] iMarker - Marker identifier.
559-
* \param[in] iVertex - Vertex identifier.
560-
* \param[in] LoadX - Value of the load in the direction X.
561-
* \param[in] LoadX - Value of the load in the direction Y.
562-
* \param[in] LoadX - Value of the load in the direction Z.
563-
*/
564-
void SetFEA_Loads(unsigned short iMarker, unsigned long iVertex, passivedouble LoadX, passivedouble LoadY,
565-
passivedouble LoadZ);
566-
567-
/*!
568-
* \brief Get the sensitivity of the flow loads for the structural solver.
569-
* \param[in] iMarker - Marker identifier.
570-
* \param[in] iVertex - Vertex identifier.
571-
* \param[in] LoadX - Value of the load in the direction X.
572-
* \param[in] LoadX - Value of the load in the direction Y.
573-
* \param[in] LoadX - Value of the load in the direction Z.
574-
*/
575-
vector<passivedouble> GetFlowLoad_Sensitivity(unsigned short iMarker, unsigned long iVertex) const;
576-
577-
/*!
578-
* \brief Get the flow load (from the extra step - the repeated methods should be unified once the postprocessing
579-
* strategy is in place).
580-
* \param[in] iMarker - Marker identifier.
581-
* \param[in] iVertex - Vertex identifier.
582-
*/
583-
vector<passivedouble> GetFlowLoad(unsigned short iMarker, unsigned long iVertex) const;
584-
585-
/*!
586-
* \brief Set the adjoint of the flow tractions (from the extra step -
587-
* the repeated methods should be unified once the postprocessing strategy is in place).
588-
* \param[in] iMarker - Marker identifier.
589-
* \param[in] iVertex - Vertex identifier.
590-
* \param[in] val_AdjointX - Value of the adjoint in the direction X.
591-
* \param[in] val_AdjointY - Value of the adjoint in the direction Y.
592-
* \param[in] val_AdjointZ - Value of the adjoint in the direction Z.
593-
*/
594-
void SetFlowLoad_Adjoint(unsigned short iMarker, unsigned long iVertex, passivedouble val_AdjointX,
595-
passivedouble val_AdjointY, passivedouble val_AdjointZ);
596-
597-
/*!
598-
* \brief Set the adjoint of the structural displacements (from an outside source)
599-
* \param[in] iMarker - Marker identifier.
600-
* \param[in] iVertex - Vertex identifier.
601-
* \param[in] val_AdjointX - Value of the adjoint in the direction X.
602-
* \param[in] val_AdjointY - Value of the adjoint in the direction Y.
603-
* \param[in] val_AdjointZ - Value of the adjoint in the direction Z.
604-
*/
605-
void SetSourceTerm_DispAdjoint(unsigned short iMarker, unsigned long iVertex, passivedouble val_AdjointX,
606-
passivedouble val_AdjointY, passivedouble val_AdjointZ);
607-
void SetSourceTerm_VelAdjoint(unsigned short iMarker, unsigned long iVertex, passivedouble val_AdjointX,
608-
passivedouble val_AdjointY, passivedouble val_AdjointZ);
609-
610489
/*!
611490
* \brief Set the position of the heat source.
612491
* \param[in] alpha - Angle of rotation respect to Z axis.

0 commit comments

Comments
 (0)