File: PetscObjectBaseTypeCompareAny.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (44 lines) | stat: -rw-r--r-- 3,541 bytes parent folder | download
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
42
43
44
<!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/PetscObjectBaseTypeCompareAny.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscObjectBaseTypeCompareAny</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/PetscObjectBaseTypeCompareAny.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscObjectBaseTypeCompareAny"><H1>PetscObjectBaseTypeCompareAny</H1></A>
Determines whether a PETSc object has the base type of any of a list of types. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h"    
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscObjectBaseTypeCompareAny.html#PetscObjectBaseTypeCompareAny">PetscObjectBaseTypeCompareAny</A>(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> obj,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> *match,const char type_name[],...)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>obj </B></TD><TD>- any PETSc object, for example a <A HREF="../Vec/Vec.html#Vec">Vec</A>, <A HREF="../Mat/Mat.html#Mat">Mat</A> or <A HREF="../KSP/KSP.html#KSP">KSP</A>.
This must be cast with a (<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>), for example, <A HREF="../Sys/PetscObjectBaseTypeCompareAny.html#PetscObjectBaseTypeCompareAny">PetscObjectBaseTypeCompareAny</A>((<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>)mat,...);
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>type_name </B></TD><TD>- string containing a type name, pass the empty string "" to terminate the list
</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>match </B></TD><TD>- <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> if the type of obj matches any in the list, else <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Vec/VecGetType.html#VecGetType">VecGetType</A>(), <A HREF="../KSP/KSPGetType.html#KSPGetType">KSPGetType</A>(), <A HREF="../PC/PCGetType.html#PCGetType">PCGetType</A>(), <A HREF="../SNES/SNESGetType.html#SNESGetType">SNESGetType</A>(), <A HREF="../Sys/PetscObjectTypeCompare.html#PetscObjectTypeCompare">PetscObjectTypeCompare</A>(), <A HREF="../Sys/PetscObjectBaseTypeCompare.html#PetscObjectBaseTypeCompare">PetscObjectBaseTypeCompare</A>(), <A HREF="../Sys/PetscObjectTypeCompareAny.html#PetscObjectTypeCompareAny">PetscObjectTypeCompareAny</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/sys/objects/destroy.c.html#PetscObjectBaseTypeCompareAny">src/sys/objects/destroy.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>