Functions of the driver classes (Iterative solution strategy) that can be used to customize SU2 via Python. For example, set custom temperature distributions at boundaries, deform the mesh, etc. More...

Classes
class	CPyWrapperMatrixView
	This class wraps su2activematrix for the python wrapper matrix interface. It is generaly used to wrap access to solver variables defined for the entire volume. More...

class	CPyWrapperMarkerMatrixView
	This class wraps su2activematrix for the python wrapper matrix interface restricting it to the vertices of a given marker. More...

class	CPyWrapper3DMatrixView
	This class wraps C3DDoubleMatrix for the python wrapper matrix interface. It is generaly used to wrap access to solver gradients defined for the entire volume. More...

Functions
void	CDriver::BoundaryConditionsUpdate ()
	Process the boundary conditions and update the multi-grid structure.

unsigned long	CDriver::GetNumberTimeIter () const
	Get the number of time iterations.

unsigned long	CDriver::GetTimeIter () const
	Get the current time iteration.

passivedouble	CDriver::GetUnsteadyTimeStep () const
	Get the unsteady time step.

string	CDriver::GetSurfaceFileName () const
	Get the name of the output file for the surface.

void	CDriver::SetHeatSourcePosition (passivedouble alpha, passivedouble pos_x, passivedouble pos_y, passivedouble pos_z)
	Set the position of the heat source.

void	CDriver::SetInletAngle (unsigned short iMarker, passivedouble alpha)
	Set the direction of the inlet.

void	CDriver::SetFarFieldAoA (passivedouble alpha)
	Set the angle of attack of the farfield.

void	CDriver::SetFarFieldAoS (passivedouble beta)
	Set the angle of sideslip of the farfield.

void	CDriver::SetTranslationRate (passivedouble xDot, passivedouble yDot, passivedouble zDot)
	Set the dynamic mesh translation rates.

void	CDriver::SetRotationRate (passivedouble rot_x, passivedouble rot_y, passivedouble rot_z)
	Set the dynamic mesh rotation rates.

void	CDriver::SetMarkerRotationRate (unsigned short iMarker, passivedouble rot_x, passivedouble rot_y, passivedouble rot_z)
	Set the moving wall marker rotation rates.

void	CDriver::SetMarkerTranslationRate (unsigned short iMarker, passivedouble vel_x, passivedouble vel_y, passivedouble vel_z)
	Set the moving wall marker translation rates.

passivedouble	CDriver::GetDensityFreeStreamND () const
	Get the Freestream Density for nondimensionalization.

passivedouble	CDriver::GetForceRef () const
	Get the reference Body force for nondimensionalization.

vector< string >	CDriverBase::GetOutputNames () const
	Get the list of available outputs.

passivedouble	CDriverBase::GetOutputValue (const std::string &output_name) const
	Get the value of one of the available history outputs.

vector< string >	CDriverBase::GetMarkerOutputNames () const
	Get the list of available surface outputs on both MARKER_MONITORING and MARKER_ANALYZE.

passivedouble	CDriverBase::GetMarkerMonitoringOutputValue (const std::string &output_name, const std::string &marker_monitoring) const
	Get the value of one of the available surface outputs at a given MARKER_MONITORING.

passivedouble	CDriverBase::GetMarkerAnalyzeOutputValue (const std::string &output_name, const std::string &marker_analyze) const
	Get the value of one of the available surface outputs at a given MARKER_ANALYZE.

unsigned short	CDriverBase::GetNumberDesignVariables () const
	Get the number of design variables.

unsigned short	CDriverBase::GetNumberFFDBoxes () const
	Get the number of FFD boxes.

unsigned long	CDriverBase::GetNumberDimensions () const
	Get the number of dimensions of the mesh.

unsigned long	CDriverBase::GetNumberElements () const
	Get the number of elements in the mesh.

unsigned long	CDriverBase::GetElementGlobalIndex (unsigned long iElem) const
	Get the global index of a mesh element.

vector< unsigned long >	CDriverBase::GetElementNodes (unsigned long iElem) const
	Get the node indices of a mesh element.

unsigned long	CDriverBase::GetNumberNodes () const
	Get the number of nodes in the mesh (including halos).

unsigned long	CDriverBase::GetNumberHaloNodes () const
	Get the number of halo nodes in the mesh.

unsigned long	CDriverBase::GetNodeGlobalIndex (unsigned long iPoint) const
	Get the global node index.

bool	CDriverBase::GetNodeDomain (unsigned long iPoint) const
	Get the halo flag of a mesh node.

CPyWrapperMatrixView	CDriverBase::InitialCoordinates () const
	Get a read-only view of the initial (undeformed) coordinates of all mesh nodes.

CPyWrapperMarkerMatrixView	CDriverBase::MarkerInitialCoordinates (unsigned short iMarker) const
	Get a read-only view of the initial (undeformed) coordinates of the mesh nodes of a marker.

CPyWrapperMatrixView	CDriverBase::Coordinates ()
	Get a read/write view of the current coordinates of all mesh nodes.

CPyWrapperMarkerMatrixView	CDriverBase::MarkerCoordinates (unsigned short iMarker)
	Get a read/write view of the current coordinates of the mesh nodes of a marker.

unsigned short	CDriverBase::GetNumberMarkers () const
	Get the number of markers in the mesh.

map< string, unsigned short >	CDriverBase::GetMarkerIndices () const
	Get all the boundary markers tags with their associated indices.

map< string, string >	CDriverBase::GetMarkerTypes () const
	Get all the boundary markers tags with their associated types.

vector< string >	CDriverBase::GetMarkerTags () const
	Get all the boundary marker tags.

vector< string >	CDriverBase::GetDeformableMarkerTags () const
	Get all the deformable boundary marker tags.

vector< string >	CDriverBase::GetCHTMarkerTags () const
	Get all the CHT boundary marker tags.

vector< string >	CDriverBase::GetInletMarkerTags () const
	Get all the inlet boundary marker tags.

unsigned long	CDriverBase::GetNumberMarkerElements (unsigned short iMarker) const
	Get the number of elements in the marker.

unsigned long	CDriverBase::GetMarkerElementGlobalIndex (unsigned short iMarker, unsigned long iElem) const
	Get the global index of a marker element.

vector< unsigned long >	CDriverBase::GetMarkerElementNodes (unsigned short iMarker, unsigned long iElem) const
	Get the node indices of a marker element.

unsigned long	CDriverBase::GetNumberMarkerNodes (unsigned short iMarker) const
	Get the number of nodes in the marker.

unsigned long	CDriverBase::GetMarkerNode (unsigned short iMarker, unsigned long iVertex) const
	Get the node index of a marker.

vector< passivedouble >	CDriverBase::GetMarkerVertexNormals (unsigned short iMarker, unsigned long iVertex, bool normalize=false) const
	Get the normal vector of a marker vertex.

vector< passivedouble >	CDriverBase::GetMarkerDisplacement (unsigned short iMarker, unsigned long iVertex) const
	Get the displacements currently imposed of a marker vertex.

void	CDriverBase::SetMarkerCustomDisplacement (unsigned short iMarker, unsigned long iVertex, vector< passivedouble > values)
	Set the mesh displacements of a marker vertex.

vector< passivedouble >	CDriverBase::GetMarkerMeshVelocity (unsigned short iMarker, unsigned long iVertex) const
	Get the mesh velocities currently imposed on a marker vertex.

void	CDriverBase::SetMarkerCustomMeshVelocity (unsigned short iMarker, unsigned long iVertex, vector< passivedouble > values)
	Set the velocities of a marker vertex.

void	CDriverBase::CommunicateMeshDisplacements (void)
	Communicate the boundary mesh displacements.

map< string, unsigned short >	CDriverBase::GetSolverIndices () const
	Get all the active solver names with their associated indices (which can be used to access their data).

map< string, unsigned short >	CDriverBase::GetFEASolutionIndices () const
	Get the structural solver solution variable names with their associated indices. These correspond to the column indices in the matrix returned by e.g. Solution().

CPyWrapperMatrixView	CDriverBase::Solution (unsigned short iSolver)
	Get a read/write view of the current solution on all mesh nodes of a solver.

CPyWrapper3DMatrixView	CDriverBase::Gradient (unsigned short iSolver)
	Get read/write view of the gradients of a solver variable in a point.

CPyWrapperMatrixView	CDriverBase::UserDefinedSource (unsigned short iSolver)
	Get a read/write view of the user defined source on all mesh nodes of a solver.

CPyWrapperMarkerMatrixView	CDriverBase::MarkerSolution (unsigned short iSolver, unsigned short iMarker)
	Get a read/write view of the current solution on the mesh nodes of a marker.

CPyWrapperMatrixView	CDriverBase::SolutionTimeN (unsigned short iSolver)
	Get a read/write view of the solution at time N on all mesh nodes of a solver.

CPyWrapperMarkerMatrixView	CDriverBase::MarkerSolutionTimeN (unsigned short iSolver, unsigned short iMarker)
	Get a read/write view of the solution at time N on the mesh nodes of a marker.

CPyWrapperMatrixView	CDriverBase::SolutionTimeN1 (unsigned short iSolver)
	Get a read/write view of the solution at time N-1 on all mesh nodes of a solver.

CPyWrapperMarkerMatrixView	CDriverBase::MarkerSolutionTimeN1 (unsigned short iSolver, unsigned short iMarker)
	Get a read/write view of the solution at time N-1 on the mesh nodes of a marker.

map< string, unsigned short >	CDriverBase::GetPrimitiveIndices () const
	Get the flow solver primitive variable names with their associated indices. These correspond to the column indices in the matrix returned by Primitives.

CPyWrapperMatrixView	CDriverBase::Primitives ()
	Get a read/write view of the current primitive variables on all mesh nodes of the flow solver.

CPyWrapperMarkerMatrixView	CDriverBase::MarkerPrimitives (unsigned short iMarker)
	Get a read/write view of the current primitive variables on the mesh nodes of a marker.

CPyWrapperMatrixView	CDriverBase::Sensitivity (unsigned short iSolver)
	Get a read-only view of the geometry sensitivity of a discrete adjoint solver.

void	CDriverBase::SetMarkerCustomTemperature (unsigned short iMarker, unsigned long iVertex, passivedouble WallTemp)
	Set the temperature of a vertex on a specified marker (MARKER_PYTHON_CUSTOM).

void	CDriverBase::SetMarkerCustomNormalHeatFlux (unsigned short iMarker, unsigned long iVertex, passivedouble WallHeatFlux)
	Set the wall normal heat flux at a vertex on a specified marker (MARKER_PYTHON_CUSTOM).

void	CDriverBase::SetMarkerCustomScalar (unsigned short iMarker, unsigned long iVertex, vector< passivedouble > WallScalar)
	Set the wall normal scalar values at a vertex on a specified marker (MARKER_PYTHON_CUSTOM).

void	CDriverBase::SelectZone (unsigned short iZone)
	Selects zone to be used for python driver operations.

unsigned short	CDriverBase::SelectedZone () const
	Returns the index of the zone selected for python driver operations.

passivedouble	CDriverBase::GetMarkerNormalHeatFlux (unsigned short iSolver, unsigned short iMarker, unsigned long iVertex) const
	Get the wall normal heat flux at a vertex on a specified marker of the flow or heat solver.

void	CDriverBase::SetMarkerCustomFEALoad (unsigned short iMarker, unsigned long iVertex, std::vector< passivedouble > force)
	Sets the nodal force for the structural solver at a vertex of a marker.

vector< passivedouble >	CDriverBase::GetMarkerFlowLoad (unsigned short iMarker, unsigned long iVertex) const
	Get the fluid force at a vertex of a solid wall marker of the flow solver.

void	CDriverBase::SetMarkerCustomFlowLoadAdjoint (unsigned short iMarker, unsigned long iVertex, vector< passivedouble > adjointLoad)
	Set the adjoint of the flow tractions of the flow solver.

vector< passivedouble >	CDriverBase::GetMarkerDisplacementSensitivity (unsigned short iMarker, unsigned long iVertex) const
	Get the sensitivities of the displacements of the mesh boundary vertices.

vector< passivedouble >	CDriverBase::GetMarkerFEALoadSensitivity (unsigned short iMarker, unsigned long iVertex) const
	Get the sensitivity of the FEA loads of the structural solver (via the adjoint structural solver).

void	CDriverBase::SetMarkerCustomFEADisplacementAdjoint (unsigned short iMarker, unsigned long iVertex, vector< passivedouble > adjointDisplacement)
	Set the adjoint of the structural displacements.

void	CDriverBase::SetMarkerCustomFEAVelocityAdjoint (unsigned short iMarker, unsigned long iVertex, vector< passivedouble > adjointVelocity)
	Set the adjoint of the structural velocities.

void	CDriverBase::SetMarkerCustomInletFlowVar0 (unsigned short iMarker, unsigned long iVertex, passivedouble value)
	Set the first variable in MARKER_INLET (usually temperature).

void	CDriverBase::SetMarkerCustomInletFlowVar1 (unsigned short iMarker, unsigned long iVertex, passivedouble value)
	Set the second variable in MARKER_INLET (usually total pressure).

void	CDriverBase::SetMarkerCustomInletFlowDirection (unsigned short iMarker, unsigned long iVertex, std::vector< passivedouble > values)
	Set the flow direction vector (does not need to be a unit vector).

Detailed Description

Functions of the driver classes (Iterative solution strategy) that can be used to customize SU2 via Python. For example, set custom temperature distributions at boundaries, deform the mesh, etc.

Function Documentation

◆ BoundaryConditionsUpdate()

void CDriver::BoundaryConditionsUpdate ( )

Process the boundary conditions and update the multi-grid structure.

◆ CommunicateMeshDisplacements()

void CDriverBase::CommunicateMeshDisplacements ( void )

Communicate the boundary mesh displacements.

◆ Coordinates()

CPyWrapperMatrixView CDriverBase::Coordinates ( )

inline

Get a read/write view of the current coordinates of all mesh nodes.

◆ GetCHTMarkerTags()

vector< string > CDriverBase::GetCHTMarkerTags ( ) const

Get all the CHT boundary marker tags.

Returns: List of CHT boundary markers tags.

◆ GetDeformableMarkerTags()

vector< string > CDriverBase::GetDeformableMarkerTags ( ) const

Get all the deformable boundary marker tags.

Returns: List of deformable boundary markers tags.

◆ GetDensityFreeStreamND()

passivedouble CDriver::GetDensityFreeStreamND ( ) const

Get the Freestream Density for nondimensionalization.

Returns: Freestream Density

◆ GetElementGlobalIndex()

unsigned long CDriverBase::GetElementGlobalIndex ( unsigned long iElem ) const

Get the global index of a mesh element.

Parameters

[in] iElem - Mesh element index.

Returns: Global element index.

◆ GetElementNodes()

vector< unsigned long > CDriverBase::GetElementNodes ( unsigned long iElem ) const

Get the node indices of a mesh element.

Parameters

[in] iElem - Mesh element index.

Returns: Element node indices (nNode).

◆ GetFEASolutionIndices()

std::map< string, unsigned short > CDriverBase::GetFEASolutionIndices ( ) const

Get the structural solver solution variable names with their associated indices. These correspond to the column indices in the matrix returned by e.g. Solution().

◆ GetForceRef()

passivedouble CDriver::GetForceRef ( ) const

Get the reference Body force for nondimensionalization.

Returns: reference Body Force

◆ GetInletMarkerTags()

vector< string > CDriverBase::GetInletMarkerTags ( ) const

Get all the inlet boundary marker tags.

Returns: List of inlet boundary markers tags.

◆ GetMarkerAnalyzeOutputValue()

passivedouble CDriverBase::GetMarkerAnalyzeOutputValue	(	const std::string &	output_name,
		const std::string &	marker_analyze
	)		const

inline

Get the value of one of the available surface outputs at a given MARKER_ANALYZE.

Returns: Value of the output.

◆ GetMarkerDisplacement()

vector< passivedouble > CDriverBase::GetMarkerDisplacement	(	unsigned short	iMarker,
		unsigned long	iVertex
	)		const

inline

Get the displacements currently imposed of a marker vertex.

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.

Returns: Node displacements (nDim).

◆ GetMarkerDisplacementSensitivity()

vector< passivedouble > CDriverBase::GetMarkerDisplacementSensitivity	(	unsigned short	iMarker,
		unsigned long	iVertex
	)		const

inline

Get the sensitivities of the displacements of the mesh boundary vertices.

Note: This can be the output of the flow solver in an adjoint FSI setting.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.

Returns: Vector of sensitivities.

◆ GetMarkerElementGlobalIndex()

unsigned long CDriverBase::GetMarkerElementGlobalIndex	(	unsigned short	iMarker,
		unsigned long	iElem
	)		const

Get the global index of a marker element.

Parameters

[in]	iMarker	- Marker index.
[in]	iElem	- Marker element index.

Returns: Global element index.

◆ GetMarkerElementNodes()

vector< unsigned long > CDriverBase::GetMarkerElementNodes	(	unsigned short	iMarker,
		unsigned long	iElem
	)		const

Get the node indices of a marker element.

Parameters

[in]	iMarker	- Marker index.
[in]	iElem	- Marker element index.

Returns: Element node indices.

◆ GetMarkerFEALoadSensitivity()

vector< passivedouble > CDriverBase::GetMarkerFEALoadSensitivity	(	unsigned short	iMarker,
		unsigned long	iVertex
	)		const

inline

Get the sensitivity of the FEA loads of the structural solver (via the adjoint structural solver).

Note: This can be the output of the FEA solver in an adjoint FSI setting.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.

Returns: Vector of sensitivities.

◆ GetMarkerFlowLoad()

vector< passivedouble > CDriverBase::GetMarkerFlowLoad	(	unsigned short	iMarker,
		unsigned long	iVertex
	)		const

inline

Get the fluid force at a vertex of a solid wall marker of the flow solver.

Note: This can be the output of the flow solver in an FSI setting to then apply it to a structural solver.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.

Returns: Vector of loads.

◆ GetMarkerIndices()

map< string, unsigned short > CDriverBase::GetMarkerIndices ( ) const

Get all the boundary markers tags with their associated indices.

Returns: Map of boundary markers tags to their indices.

◆ GetMarkerMeshVelocity()

vector< passivedouble > CDriverBase::GetMarkerMeshVelocity	(	unsigned short	iMarker,
		unsigned long	iVertex
	)		const

inline

Get the mesh velocities currently imposed on a marker vertex.

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.

Returns: Node velocities (nDim).

◆ GetMarkerMonitoringOutputValue()

passivedouble CDriverBase::GetMarkerMonitoringOutputValue	(	const std::string &	output_name,
		const std::string &	marker_monitoring
	)		const

inline

Get the value of one of the available surface outputs at a given MARKER_MONITORING.

Returns: Value of the output.

◆ GetMarkerNode()

unsigned long CDriverBase::GetMarkerNode	(	unsigned short	iMarker,
		unsigned long	iVertex
	)		const

Get the node index of a marker.

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.

Returns: Marker vertex.

◆ GetMarkerNormalHeatFlux()

passivedouble CDriverBase::GetMarkerNormalHeatFlux	(	unsigned short	iSolver,
		unsigned short	iMarker,
		unsigned long	iVertex
	)		const

inline

Get the wall normal heat flux at a vertex on a specified marker of the flow or heat solver.

Note: This can be the output of a heat or flow solver in a CHT setting.

Parameters

[in]	iSolver	- Solver identifier, should be either a flow solver or the heat solver.
[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.

Returns: Wall normal component of the heat flux at the vertex.

◆ GetMarkerOutputNames()

vector< string > CDriverBase::GetMarkerOutputNames ( ) const

inline

Get the list of available surface outputs on both MARKER_MONITORING and MARKER_ANALYZE.

Returns: List of surface output names.

◆ GetMarkerTags()

vector< string > CDriverBase::GetMarkerTags ( ) const

Get all the boundary marker tags.

Returns: List of boundary markers tags.

◆ GetMarkerTypes()

map< string, string > CDriverBase::GetMarkerTypes ( ) const

Get all the boundary markers tags with their associated types.

Returns: Map of boundary markers tags to their types.

◆ GetMarkerVertexNormals()

vector< passivedouble > CDriverBase::GetMarkerVertexNormals	(	unsigned short	iMarker,
		unsigned long	iVertex,
		bool	normalize = `false`
	)		const

Get the normal vector of a marker vertex.

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.
[in]	normalize	- If true, the unit (i.e. normalized) normal vector is returned.

Returns: Node normal vector (nDim).

◆ GetNodeDomain()

bool CDriverBase::GetNodeDomain ( unsigned long iPoint ) const

Get the halo flag of a mesh node.

Parameters

[in] iPoint - Mesh node index.

Returns: Node domain flag.

◆ GetNodeGlobalIndex()

unsigned long CDriverBase::GetNodeGlobalIndex ( unsigned long iPoint ) const

Get the global node index.

Parameters

[in] iPoint - Mesh node index.

Returns: Global node index.

◆ GetNumberDesignVariables()

unsigned short CDriverBase::GetNumberDesignVariables ( ) const

Get the number of design variables.

Returns: Number of design variables.

◆ GetNumberDimensions()

unsigned long CDriverBase::GetNumberDimensions ( ) const

Get the number of dimensions of the mesh.

Returns: Number of dimensions.

◆ GetNumberElements()

unsigned long CDriverBase::GetNumberElements ( ) const

Get the number of elements in the mesh.

Returns: Number of elements.

◆ GetNumberFFDBoxes()

unsigned short CDriverBase::GetNumberFFDBoxes ( ) const

Get the number of FFD boxes.

Returns: Number of FFD boxes.

◆ GetNumberHaloNodes()

unsigned long CDriverBase::GetNumberHaloNodes ( ) const

Get the number of halo nodes in the mesh.

Returns: Number of halo nodes.

◆ GetNumberMarkerElements()

unsigned long CDriverBase::GetNumberMarkerElements ( unsigned short iMarker ) const

Get the number of elements in the marker.

Parameters

[in] iMarker - Marker index.

Returns: Number of elements.

◆ GetNumberMarkerNodes()

unsigned long CDriverBase::GetNumberMarkerNodes ( unsigned short iMarker ) const

Get the number of nodes in the marker.

Parameters

[in] iMarker - Marker index.

Returns: Number of nodes.

◆ GetNumberMarkers()

unsigned short CDriverBase::GetNumberMarkers ( ) const

Get the number of markers in the mesh.

Returns: Number of markers.

◆ GetNumberNodes()

unsigned long CDriverBase::GetNumberNodes ( ) const

Get the number of nodes in the mesh (including halos).

Returns: Number of nodes.

◆ GetNumberTimeIter()

unsigned long CDriver::GetNumberTimeIter ( ) const

Get the number of time iterations.

Returns: Number of time iterations.

◆ GetOutputNames()

vector< string > CDriverBase::GetOutputNames ( ) const

inline

Get the list of available outputs.

Returns: List of output names.

◆ GetOutputValue()

passivedouble CDriverBase::GetOutputValue ( const std::string & output_name ) const

inline

Get the value of one of the available history outputs.

Returns: Value of the output.

◆ GetPrimitiveIndices()

map< string, unsigned short > CDriverBase::GetPrimitiveIndices ( ) const

Get the flow solver primitive variable names with their associated indices. These correspond to the column indices in the matrix returned by Primitives.

◆ GetSolverIndices()

map< string, unsigned short > CDriverBase::GetSolverIndices ( ) const

Get all the active solver names with their associated indices (which can be used to access their data).

◆ GetSurfaceFileName()

string CDriver::GetSurfaceFileName ( ) const

Get the name of the output file for the surface.

Returns: File name for the surface output.

◆ GetTimeIter()

unsigned long CDriver::GetTimeIter ( ) const

Get the current time iteration.

Returns: Current time iteration.

◆ GetUnsteadyTimeStep()

passivedouble CDriver::GetUnsteadyTimeStep ( ) const

Get the unsteady time step.

Returns: Unsteady time step.

◆ Gradient()

CPyWrapper3DMatrixView CDriverBase::Gradient ( unsigned short iSolver )

inline

Get read/write view of the gradients of a solver variable in a point.

◆ InitialCoordinates()

CPyWrapperMatrixView CDriverBase::InitialCoordinates ( ) const

inline

Get a read-only view of the initial (undeformed) coordinates of all mesh nodes.

◆ MarkerCoordinates()

CPyWrapperMarkerMatrixView CDriverBase::MarkerCoordinates ( unsigned short iMarker )

inline

Get a read/write view of the current coordinates of the mesh nodes of a marker.

◆ MarkerInitialCoordinates()

CPyWrapperMarkerMatrixView CDriverBase::MarkerInitialCoordinates ( unsigned short iMarker ) const

inline

Get a read-only view of the initial (undeformed) coordinates of the mesh nodes of a marker.

◆ MarkerPrimitives()

CPyWrapperMarkerMatrixView CDriverBase::MarkerPrimitives ( unsigned short iMarker )

inline

Get a read/write view of the current primitive variables on the mesh nodes of a marker.

Warning: Primitive variables are only available for flow solvers.

◆ MarkerSolution()

CPyWrapperMarkerMatrixView CDriverBase::MarkerSolution	(	unsigned short	iSolver,
		unsigned short	iMarker
	)

inline

Get a read/write view of the current solution on the mesh nodes of a marker.

◆ MarkerSolutionTimeN()

CPyWrapperMarkerMatrixView CDriverBase::MarkerSolutionTimeN	(	unsigned short	iSolver,
		unsigned short	iMarker
	)

inline

Get a read/write view of the solution at time N on the mesh nodes of a marker.

◆ MarkerSolutionTimeN1()

CPyWrapperMarkerMatrixView CDriverBase::MarkerSolutionTimeN1	(	unsigned short	iSolver,
		unsigned short	iMarker
	)

inline

Get a read/write view of the solution at time N-1 on the mesh nodes of a marker.

◆ Primitives()

CPyWrapperMatrixView CDriverBase::Primitives ( )

inline

Get a read/write view of the current primitive variables on all mesh nodes of the flow solver.

Warning: Primitive variables are only available for flow solvers.

◆ SelectedZone()

unsigned short CDriverBase::SelectedZone ( ) const

inline

Returns the index of the zone selected for python driver operations.

◆ SelectZone()

void CDriverBase::SelectZone ( unsigned short iZone )

inline

Selects zone to be used for python driver operations.

Parameters

[in] iZone - Zone identifier.

◆ Sensitivity()

CPyWrapperMatrixView CDriverBase::Sensitivity ( unsigned short iSolver )

inline

Get a read-only view of the geometry sensitivity of a discrete adjoint solver.

◆ SetFarFieldAoA()

void CDriver::SetFarFieldAoA ( passivedouble alpha )

Set the angle of attack of the farfield.

Parameters

[in] alpha - Angle (degree).

◆ SetFarFieldAoS()

void CDriver::SetFarFieldAoS ( passivedouble beta )

Set the angle of sideslip of the farfield.

Parameters

[in] beta - Angle (degree).

◆ SetHeatSourcePosition()

void CDriver::SetHeatSourcePosition	(	passivedouble	alpha,
		passivedouble	pos_x,
		passivedouble	pos_y,
		passivedouble	pos_z
	)

Set the position of the heat source.

Parameters

[in]	alpha	- Angle of rotation respect to Z axis.
[in]	pos_x	- Position X.
[in]	pos_y	- Position Y.
[in]	pos_z	- Position Z.

◆ SetInletAngle()

void CDriver::SetInletAngle	(	unsigned short	iMarker,
		passivedouble	alpha
	)

Set the direction of the inlet.

Parameters

[in]	iMarker	- Marker index.
[in]	alpha	- Angle around z axis.

◆ SetMarkerCustomDisplacement()

void CDriverBase::SetMarkerCustomDisplacement	(	unsigned short	iMarker,
		unsigned long	iVertex,
		vector< passivedouble >	values
	)

inline

Set the mesh displacements of a marker vertex.

Note: This can be the input of the flow solver in an FSI setting.

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.
[in]	values	- Node displacements (nDim).

◆ SetMarkerCustomFEADisplacementAdjoint()

void CDriverBase::SetMarkerCustomFEADisplacementAdjoint	(	unsigned short	iMarker,
		unsigned long	iVertex,
		vector< passivedouble >	adjointDisplacement
	)

inline

Set the adjoint of the structural displacements.

Note: This can be the input of the FEA solver in an adjoint FSI setting.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.
[in]	adjointDisplacement	- Vector of adjoint displacements.

◆ SetMarkerCustomFEALoad()

void CDriverBase::SetMarkerCustomFEALoad	(	unsigned short	iMarker,
		unsigned long	iVertex,
		std::vector< passivedouble >	force
	)

inline

Sets the nodal force for the structural solver at a vertex of a marker.

Note: This can be the input of the FEA solver in an FSI setting.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.
[in]	force	- Force vector.

◆ SetMarkerCustomFEAVelocityAdjoint()

void CDriverBase::SetMarkerCustomFEAVelocityAdjoint	(	unsigned short	iMarker,
		unsigned long	iVertex,
		vector< passivedouble >	adjointVelocity
	)

inline

Set the adjoint of the structural velocities.

Note: This can be the input of the FEA solver in an unsteady adjoint FSI setting.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.
[in]	adjointVelocity	- Vector of adjoint velocities.

◆ SetMarkerCustomFlowLoadAdjoint()

void CDriverBase::SetMarkerCustomFlowLoadAdjoint	(	unsigned short	iMarker,
		unsigned long	iVertex,
		vector< passivedouble >	adjointLoad
	)

inline

Set the adjoint of the flow tractions of the flow solver.

Note: This can be the input of the flow solver in an adjoint FSI setting.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.
[in]	adjointLoad	- Vector of adjoint loads.

◆ SetMarkerCustomInletFlowDirection()

void CDriverBase::SetMarkerCustomInletFlowDirection	(	unsigned short	iMarker,
		unsigned long	iVertex,
		std::vector< passivedouble >	values
	)

inline

Set the flow direction vector (does not need to be a unit vector).

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.
[in]	values	- Flow direction vector.

◆ SetMarkerCustomInletFlowVar0()

void CDriverBase::SetMarkerCustomInletFlowVar0	(	unsigned short	iMarker,
		unsigned long	iVertex,
		passivedouble	value
	)

inline

Set the first variable in MARKER_INLET (usually temperature).

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.
[in]	value	- Value of the variable.

◆ SetMarkerCustomInletFlowVar1()

void CDriverBase::SetMarkerCustomInletFlowVar1	(	unsigned short	iMarker,
		unsigned long	iVertex,
		passivedouble	value
	)

inline

Set the second variable in MARKER_INLET (usually total pressure).

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.
[in]	value	- Value of the variable.

◆ SetMarkerCustomMeshVelocity()

void CDriverBase::SetMarkerCustomMeshVelocity	(	unsigned short	iMarker,
		unsigned long	iVertex,
		vector< passivedouble >	values
	)

inline

Set the velocities of a marker vertex.

Note: This can be the input of the flow solver in an unsteady FSI setting.

Parameters

[in]	iMarker	- Marker index.
[in]	iVertex	- Marker vertex index.
[in]	values	- Node velocities (nDim).

◆ SetMarkerCustomNormalHeatFlux()

void CDriverBase::SetMarkerCustomNormalHeatFlux	(	unsigned short	iMarker,
		unsigned long	iVertex,
		passivedouble	WallHeatFlux
	)

inline

Set the wall normal heat flux at a vertex on a specified marker (MARKER_PYTHON_CUSTOM).

Note: This can be the input of a heat or flow solver in a CHT setting.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.
[in]	WallHeatFlux	- Value of the normal heat flux.

◆ SetMarkerCustomScalar()

void CDriverBase::SetMarkerCustomScalar	(	unsigned short	iMarker,
		unsigned long	iVertex,
		vector< passivedouble >	WallScalar
	)

inline

Set the wall normal scalar values at a vertex on a specified marker (MARKER_PYTHON_CUSTOM).

Note: This can be the input of a scalar transport equation.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.
[in]	WallScalar	- Value of the normal heat flux.

◆ SetMarkerCustomTemperature()

void CDriverBase::SetMarkerCustomTemperature	(	unsigned short	iMarker,
		unsigned long	iVertex,
		passivedouble	WallTemp
	)

inline

Set the temperature of a vertex on a specified marker (MARKER_PYTHON_CUSTOM).

Note: This can be the input of a heat or flow solver in a CHT setting.

Parameters

[in]	iMarker	- Marker identifier.
[in]	iVertex	- Vertex identifier.
[in]	WallTemp	- Value of the temperature.

◆ SetMarkerRotationRate()

void CDriver::SetMarkerRotationRate	(	unsigned short	iMarker,
		passivedouble	rot_x,
		passivedouble	rot_y,
		passivedouble	rot_z
	)

Set the moving wall marker rotation rates.

Parameters

[in]	iMaker	- Index of moving wall marker.
[in]	rot_x	- Value of Angular velocity about x-axes.
[in]	rot_y	- Value of Angular velocity about y-axes.
[in]	rot_z	- Value of Angular velocity about z-axes.

◆ SetMarkerTranslationRate()

void CDriver::SetMarkerTranslationRate	(	unsigned short	iMarker,
		passivedouble	vel_x,
		passivedouble	vel_y,
		passivedouble	vel_z
	)

Set the moving wall marker translation rates.

Parameters

[in]	iMaker	- Index of moving wall marker.
[in]	vel_x	- Value of velocity along x-axis.
[in]	vel_y	- Value of velocity along y-axis.
[in]	vel_z	- Value of velocity along z-axis.

◆ SetRotationRate()

void CDriver::SetRotationRate	(	passivedouble	rot_x,
		passivedouble	rot_y,
		passivedouble	rot_z
	)

Set the dynamic mesh rotation rates.

Parameters

[in]	rot_x	- Value of Angular velocity about x-axes.
[in]	rot_y	- Value of Angular velocity about y-axes.
[in]	rot_z	- Value of Angular velocity about z-axes.

◆ SetTranslationRate()

void CDriver::SetTranslationRate	(	passivedouble	xDot,
		passivedouble	yDot,
		passivedouble	zDot
	)

Set the dynamic mesh translation rates.

Parameters

[in]	xDot	- Value of translational velocity in x-direction.
[in]	yDot	- Value of translational velocity in y-direction.
[in]	zDot	- Value of translational velocity in z-direction.

◆ Solution()

CPyWrapperMatrixView CDriverBase::Solution ( unsigned short iSolver )

inline

Get a read/write view of the current solution on all mesh nodes of a solver.

◆ SolutionTimeN()

CPyWrapperMatrixView CDriverBase::SolutionTimeN ( unsigned short iSolver )

inline

Get a read/write view of the solution at time N on all mesh nodes of a solver.

◆ SolutionTimeN1()

CPyWrapperMatrixView CDriverBase::SolutionTimeN1 ( unsigned short iSolver )

inline

Get a read/write view of the solution at time N-1 on all mesh nodes of a solver.

◆ UserDefinedSource()

CPyWrapperMatrixView CDriverBase::UserDefinedSource ( unsigned short iSolver )

inline

Get a read/write view of the user defined source on all mesh nodes of a solver.

Classes

Functions

Detailed Description

Function Documentation

◆ BoundaryConditionsUpdate()

◆ CommunicateMeshDisplacements()

◆ Coordinates()

◆ GetCHTMarkerTags()

◆ GetDeformableMarkerTags()

◆ GetDensityFreeStreamND()

◆ GetElementGlobalIndex()

◆ GetElementNodes()

◆ GetFEASolutionIndices()

◆ GetForceRef()

◆ GetInletMarkerTags()

◆ GetMarkerAnalyzeOutputValue()

◆ GetMarkerDisplacement()

◆ GetMarkerDisplacementSensitivity()

◆ GetMarkerElementGlobalIndex()

◆ GetMarkerElementNodes()

◆ GetMarkerFEALoadSensitivity()

◆ GetMarkerFlowLoad()

◆ GetMarkerIndices()

◆ GetMarkerMeshVelocity()

◆ GetMarkerMonitoringOutputValue()

◆ GetMarkerNode()

◆ GetMarkerNormalHeatFlux()

◆ GetMarkerOutputNames()

◆ GetMarkerTags()

◆ GetMarkerTypes()

◆ GetMarkerVertexNormals()

◆ GetNodeDomain()

◆ GetNodeGlobalIndex()

◆ GetNumberDesignVariables()

◆ GetNumberDimensions()

◆ GetNumberElements()

◆ GetNumberFFDBoxes()

◆ GetNumberHaloNodes()

◆ GetNumberMarkerElements()

◆ GetNumberMarkerNodes()

◆ GetNumberMarkers()

◆ GetNumberNodes()

◆ GetNumberTimeIter()

◆ GetOutputNames()

◆ GetOutputValue()

◆ GetPrimitiveIndices()

◆ GetSolverIndices()

◆ GetSurfaceFileName()

◆ GetTimeIter()

◆ GetUnsteadyTimeStep()

◆ Gradient()

◆ InitialCoordinates()

◆ MarkerCoordinates()

◆ MarkerInitialCoordinates()

◆ MarkerPrimitives()

◆ MarkerSolution()

◆ MarkerSolutionTimeN()

◆ MarkerSolutionTimeN1()

◆ Primitives()

◆ SelectedZone()

◆ SelectZone()

◆ Sensitivity()

◆ SetFarFieldAoA()

◆ SetFarFieldAoS()

◆ SetHeatSourcePosition()

◆ SetInletAngle()

◆ SetMarkerCustomDisplacement()

◆ SetMarkerCustomFEADisplacementAdjoint()

◆ SetMarkerCustomFEALoad()

◆ SetMarkerCustomFEAVelocityAdjoint()

◆ SetMarkerCustomFlowLoadAdjoint()

◆ SetMarkerCustomInletFlowDirection()

◆ SetMarkerCustomInletFlowVar0()

◆ SetMarkerCustomInletFlowVar1()

◆ SetMarkerCustomMeshVelocity()

◆ SetMarkerCustomNormalHeatFlux()

◆ SetMarkerCustomScalar()

◆ SetMarkerCustomTemperature()

◆ SetMarkerRotationRate()

◆ SetMarkerTranslationRate()