1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscOmpCtrlCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscOmpCtrlCreate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/Sys/PetscOmpCtrlCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscOmpCtrlCreate"><H1>PetscOmpCtrlCreate</H1></A>
create a PETSc OpenMP controller, which manages PETSc's interaction with third party libraries using OpenMP
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscOmpCtrlCreate.html#PetscOmpCtrlCreate">PetscOmpCtrlCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> petsc_comm,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nthreads,PetscOmpCtrl *pctrl)
</PRE>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>petsc_comm </B></TD><TD>- a communicator some PETSc object (for example, a matrix) lives in
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nthreads </B></TD><TD>- number of threads per MPI rank to spawn in a library using OpenMP. If nthreads = -1, let PETSc decide a suitable value
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pctrl </B></TD><TD>- a PETSc OpenMP controller
</TD></TR></TABLE>
<P>
<P>
TODO: Possibly use the variable PetscNumOMPThreads to determine the number for threads to use
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Sys/PetscOmpCtrlDestroy.html#PetscOmpCtrlDestroy">PetscOmpCtrlDestroy</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/sys/utils/mpishm.c.html#PetscOmpCtrlCreate">src/sys/utils/mpishm.c</A>
<BR><A HREF="./index.html">Index of all Sys routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
