xref: /petsc/src/mat/impls/transpose/transm.c (revision 702c4f2fb2b40d2bce4bfb3c8519157ae61fced8)
1 
2 #include <petsc/private/matimpl.h>          /*I "petscmat.h" I*/
3 
4 typedef struct {
5   Mat A;
6 } Mat_Transpose;
7 
8 PetscErrorCode MatMult_Transpose(Mat N,Vec x,Vec y)
9 {
10   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
11   PetscErrorCode ierr;
12 
13   PetscFunctionBegin;
14   ierr = MatMultTranspose(Na->A,x,y);CHKERRQ(ierr);
15   PetscFunctionReturn(0);
16 }
17 
18 PetscErrorCode MatMultAdd_Transpose(Mat N,Vec v1,Vec v2,Vec v3)
19 {
20   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
21   PetscErrorCode ierr;
22 
23   PetscFunctionBegin;
24   ierr = MatMultTransposeAdd(Na->A,v1,v2,v3);CHKERRQ(ierr);
25   PetscFunctionReturn(0);
26 }
27 
28 PetscErrorCode MatMultTranspose_Transpose(Mat N,Vec x,Vec y)
29 {
30   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
31   PetscErrorCode ierr;
32 
33   PetscFunctionBegin;
34   ierr = MatMult(Na->A,x,y);CHKERRQ(ierr);
35   PetscFunctionReturn(0);
36 }
37 
38 PetscErrorCode MatMultTransposeAdd_Transpose(Mat N,Vec v1,Vec v2,Vec v3)
39 {
40   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
41   PetscErrorCode ierr;
42 
43   PetscFunctionBegin;
44   ierr = MatMultAdd(Na->A,v1,v2,v3);CHKERRQ(ierr);
45   PetscFunctionReturn(0);
46 }
47 
48 PetscErrorCode MatDestroy_Transpose(Mat N)
49 {
50   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
51   PetscErrorCode ierr;
52 
53   PetscFunctionBegin;
54   ierr = MatDestroy(&Na->A);CHKERRQ(ierr);
55   ierr = PetscObjectComposeFunction((PetscObject)N,"MatTransposeGetMat_C",NULL);CHKERRQ(ierr);
56   ierr = PetscFree(N->data);CHKERRQ(ierr);
57   PetscFunctionReturn(0);
58 }
59 
60 PetscErrorCode MatDuplicate_Transpose(Mat N, MatDuplicateOption op, Mat* m)
61 {
62   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
63   PetscErrorCode ierr;
64 
65   PetscFunctionBegin;
66   if (op == MAT_COPY_VALUES) {
67     ierr = MatTranspose(Na->A,MAT_INITIAL_MATRIX,m);CHKERRQ(ierr);
68   } else if (op == MAT_DO_NOT_COPY_VALUES) {
69     ierr = MatDuplicate(Na->A,MAT_DO_NOT_COPY_VALUES,m);CHKERRQ(ierr);
70     ierr = MatTranspose(*m,MAT_INPLACE_MATRIX,m);CHKERRQ(ierr);
71   } else SETERRQ(PetscObjectComm((PetscObject)N),PETSC_ERR_SUP,"MAT_SHARE_NONZERO_PATTERN not supported for this matrix type");
72   PetscFunctionReturn(0);
73 }
74 
75 PetscErrorCode MatCreateVecs_Transpose(Mat A,Vec *r, Vec *l)
76 {
77   Mat_Transpose  *Aa = (Mat_Transpose*)A->data;
78   PetscErrorCode ierr;
79 
80   PetscFunctionBegin;
81   ierr = MatCreateVecs(Aa->A,l,r);CHKERRQ(ierr);
82   PetscFunctionReturn(0);
83 }
84 
85 PetscErrorCode MatAXPY_Transpose(Mat Y,PetscScalar a,Mat X,MatStructure str)
86 {
87   Mat_Transpose  *Ya = (Mat_Transpose*)Y->data;
88   Mat_Transpose  *Xa = (Mat_Transpose*)X->data;
89   Mat              M = Ya->A;
90   Mat              N = Xa->A;
91   PetscErrorCode ierr;
92 
93   PetscFunctionBegin;
94   ierr = MatAXPY(M,a,N,str);CHKERRQ(ierr);
95   PetscFunctionReturn(0);
96 }
97 
98 PetscErrorCode MatHasOperation_Transpose(Mat mat,MatOperation op,PetscBool *has)
99 {
100   Mat_Transpose  *X = (Mat_Transpose*)mat->data;
101   PetscErrorCode ierr;
102   PetscFunctionBegin;
103 
104   *has = PETSC_FALSE;
105   if (op == MATOP_MAT_MULT || op == MATOP_TRANSPOSE_MAT_MULT) {
106     ierr = MatHasOperation(X->A,op == MATOP_MAT_MULT ? MATOP_TRANSPOSE_MAT_MULT : MATOP_MAT_MULT,has);CHKERRQ(ierr);
107   }
108   else if (((void**)mat->ops)[op]) *has = PETSC_TRUE;
109   PetscFunctionReturn(0);
110 }
111 
112 PetscErrorCode MatTransposeGetMat_Transpose(Mat A,Mat *M)
113 {
114   Mat_Transpose  *Aa = (Mat_Transpose*)A->data;
115 
116   PetscFunctionBegin;
117   *M = Aa->A;
118   PetscFunctionReturn(0);
119 }
120 
121 /*@
122       MatTransposeGetMat - Gets the Mat object stored inside a MATTRANSPOSEMAT
123 
124    Logically collective on Mat
125 
126    Input Parameter:
127 .   A  - the MATTRANSPOSE matrix
128 
129    Output Parameter:
130 .   M - the matrix object stored inside A
131 
132    Level: intermediate
133 
134 .seealso: MatCreateTranspose()
135 
136 @*/
137 PetscErrorCode MatTransposeGetMat(Mat A,Mat *M)
138 {
139   PetscErrorCode ierr;
140 
141   PetscFunctionBegin;
142   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
143   PetscValidType(A,1);
144   PetscValidPointer(M,2);
145   ierr = PetscUseMethod(A,"MatTransposeGetMat_C",(Mat,Mat*),(A,M));CHKERRQ(ierr);
146   PetscFunctionReturn(0);
147 }
148 
149 /*@
150       MatCreateTranspose - Creates a new matrix object that behaves like A'
151 
152    Collective on Mat
153 
154    Input Parameter:
155 .   A  - the (possibly rectangular) matrix
156 
157    Output Parameter:
158 .   N - the matrix that represents A'
159 
160    Level: intermediate
161 
162    Notes:
163     The transpose A' is NOT actually formed! Rather the new matrix
164           object performs the matrix-vector product by using the MatMultTranspose() on
165           the original matrix
166 
167 .seealso: MatCreateNormal(), MatMult(), MatMultTranspose(), MatCreate()
168 
169 @*/
170 PetscErrorCode  MatCreateTranspose(Mat A,Mat *N)
171 {
172   PetscErrorCode ierr;
173   PetscInt       m,n;
174   Mat_Transpose  *Na;
175 
176   PetscFunctionBegin;
177   ierr = MatGetLocalSize(A,&m,&n);CHKERRQ(ierr);
178   ierr = MatCreate(PetscObjectComm((PetscObject)A),N);CHKERRQ(ierr);
179   ierr = MatSetSizes(*N,n,m,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
180   ierr = PetscLayoutSetUp((*N)->rmap);CHKERRQ(ierr);
181   ierr = PetscLayoutSetUp((*N)->cmap);CHKERRQ(ierr);
182   ierr = PetscObjectChangeTypeName((PetscObject)*N,MATTRANSPOSEMAT);CHKERRQ(ierr);
183 
184   ierr       = PetscNewLog(*N,&Na);CHKERRQ(ierr);
185   (*N)->data = (void*) Na;
186   ierr       = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
187   Na->A      = A;
188 
189   (*N)->ops->destroy          = MatDestroy_Transpose;
190   (*N)->ops->mult             = MatMult_Transpose;
191   (*N)->ops->multadd          = MatMultAdd_Transpose;
192   (*N)->ops->multtranspose    = MatMultTranspose_Transpose;
193   (*N)->ops->multtransposeadd = MatMultTransposeAdd_Transpose;
194   (*N)->ops->duplicate        = MatDuplicate_Transpose;
195   (*N)->ops->getvecs          = MatCreateVecs_Transpose;
196   (*N)->ops->axpy             = MatAXPY_Transpose;
197   (*N)->ops->hasoperation     = MatHasOperation_Transpose;
198   (*N)->assembled             = PETSC_TRUE;
199 
200   ierr = PetscObjectComposeFunction((PetscObject)(*N),"MatTransposeGetMat_C",MatTransposeGetMat_Transpose);CHKERRQ(ierr);
201   ierr = MatSetBlockSizes(*N,PetscAbs(A->cmap->bs),PetscAbs(A->rmap->bs));CHKERRQ(ierr);
202   ierr = MatSetUp(*N);CHKERRQ(ierr);
203   PetscFunctionReturn(0);
204 }
205 
206